From 2f45e1c27865c7b766f39ac0c63ef2b4f16cb429 Mon Sep 17 00:00:00 2001 From: eileen Date: Sun, 30 Jun 2013 10:46:28 +1200 Subject: [PATCH] preliminary tidy-up - use api function that ensures success --- tests/phpunit/api/v3/ContributionTest.php | 107 +++++++++------------- 1 file changed, 44 insertions(+), 63 deletions(-) diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php index 4ad8036b3d..70e456e89b 100644 --- a/tests/phpunit/api/v3/ContributionTest.php +++ b/tests/phpunit/api/v3/ContributionTest.php @@ -133,20 +133,18 @@ class api_v3_ContributionTest extends CiviUnitTestCase { 'contribution_status_id' => 1, 'version' => $this->_apiversion, ); - $this->_contribution = civicrm_api('contribution', 'create', $p); - $this->assertAPISuccess($this->_contribution, 0, 'In line ' . __LINE__); + $this->_contribution = $this->callAPISuccess('contribution', 'create', $p); $params = array( 'contribution_id' => $this->_contribution['id'], 'version' => $this->_apiversion, ); - $contribution = civicrm_api('contribution', 'get', $params); + $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__); $financialParams['id'] = $this->_contributionTypeId; $default = null; $financialType = CRM_Financial_BAO_FinancialType::retrieve($financialParams,$default); - $this->assertAPISuccess($contribution, 'In line ' . __LINE__); + $this->assertEquals(1,$contribution['count']); - $this->documentMe($params, $contribution, __FUNCTION__, __FILE__); $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__); // note there was an assertion converting financial_type_id to 'Donation' which wasn't working. // passing back a string rather than an id seems like an error / cruft - & if it is to be introduced we should discuss @@ -163,8 +161,8 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $p['trxn_id'] = '3847'; $p['invoice_id'] = '3847'; - $contribution2 = civicrm_api('contribution', 'create', $p); - $this->assertAPISuccess($contribution2, 'In line ' . __LINE__); + $contribution2 = $this->callAPISuccess('contribution', 'create', $p); + $params = array( 'version' => $this->_apiversion, @@ -175,7 +173,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { )); $this->assertEquals(2, $contribution); //test id only format - $contribution = civicrm_api('contribution', 'get', array + $contribution = $this->callAPISuccess('contribution', 'get', array ('version' => $this->_apiversion, 'id' => $this->_contribution['id'], 'format.only_id' => 1, @@ -183,31 +181,30 @@ class api_v3_ContributionTest extends CiviUnitTestCase { ); $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution,true) . " in line " . __LINE__); //test id only format - $contribution = civicrm_api('contribution', 'get', array + $contribution = $this->callAPISuccess('contribution', 'get', array ('version' => $this->_apiversion, 'id' => $contribution2['id'], 'format.only_id' => 1, ) ); $this->assertEquals($contribution2['id'], $contribution); - $contribution = civicrm_api('contribution', 'get', array( + $contribution = $this->callAPISuccess('contribution', 'get', array( 'version' => $this->_apiversion, 'id' => $this->_contribution['id'], )); //test id as field - $this->assertAPISuccess($contribution, 'In line ' . __LINE__); + $this->assertEquals(1, $contribution['count'], 'In line ' . __LINE__); // $this->assertEquals($this->_contribution['id'], $contribution['id'] ) ; //test get by contact id works - $contribution = civicrm_api('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId)); - $this->assertAPISuccess($contribution, 'In line ' . __LINE__ . "get with contact_id" . print_r(array('version' => $this->_apiversion, 'contact_id' => $this->_individualId), TRUE)); + $contribution = $this->callAPISuccess('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId)); $this->assertEquals(2, $contribution['count'], 'In line ' . __LINE__); - civicrm_api('Contribution', 'Delete', array( + $this->callAPISuccess('Contribution', 'Delete', array( 'id' => $this->_contribution['id'], 'version' => $this->_apiversion, )); - civicrm_api('Contribution', 'Delete', array( + $this->callAPISuccess('Contribution', 'Delete', array( 'id' => $contribution2['id'], 'version' => $this->_apiversion, )); @@ -231,20 +228,18 @@ class api_v3_ContributionTest extends CiviUnitTestCase { 'contribution_status_id' => 1, 'version' => $this->_apiversion, ); - $this->_contribution = civicrm_api('contribution', 'create', $p); - $this->assertAPISuccess($this->_contribution, 'In line ' . __LINE__); + $this->_contribution = $this->callAPISuccess('contribution', 'create', $p); $params = array( 'contribution_id' => $this->_contribution['id'], 'version' => $this->_apiversion, ); - $contribution = civicrm_api('contribution', 'get', $params); + $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__); $financialParams['id'] = $this->_contributionTypeId; $default = null; $financialType = CRM_Financial_BAO_FinancialType::retrieve($financialParams,$default); - $this->assertAPISuccess($contribution, 'In line ' . __LINE__); + $this->assertEquals(1,$contribution['count']); - $this->documentMe($params, $contribution, __FUNCTION__, __FILE__); $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__); $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_contributionTypeId); $this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_contributionTypeId); @@ -260,8 +255,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $p['trxn_id'] = '3847'; $p['invoice_id'] = '3847'; - $contribution2 = civicrm_api('contribution', 'create', $p); - $this->assertAPISuccess($contribution2, 'In line ' . __LINE__); + $contribution2 = $this->callAPISuccess('contribution', 'create', $p); $params = array( 'version' => $this->_apiversion, @@ -287,24 +281,22 @@ class api_v3_ContributionTest extends CiviUnitTestCase { ) ); $this->assertEquals($contribution2['id'], $contribution); - $contribution = civicrm_api('contribution', 'get', array( + $contribution = $this->callAPISuccess('contribution', 'get', array( 'version' => $this->_apiversion, 'id' => $this->_contribution['id'], )); //test id as field - $this->assertAPISuccess($contribution, 'In line ' . __LINE__); $this->assertEquals(1, $contribution['count'], 'In line ' . __LINE__); // $this->assertEquals($this->_contribution['id'], $contribution['id'] ) ; //test get by contact id works - $contribution = civicrm_api('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId)); - $this->assertAPISuccess($contribution, 'In line ' . __LINE__ . "get with contact_id" . print_r(array('version' => $this->_apiversion, 'contact_id' => $this->_individualId), TRUE)); + $contribution = $this->callAPISuccess('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId)); $this->assertEquals(2, $contribution['count'], 'In line ' . __LINE__); - civicrm_api('Contribution', 'Delete', array( + $this->callAPISuccess('Contribution', 'Delete', array( 'id' => $this->_contribution['id'], 'version' => $this->_apiversion, )); - civicrm_api('Contribution', 'Delete', array( + $this->callAPISuccess('Contribution', 'Delete', array( 'id' => $contribution2['id'], 'version' => $this->_apiversion, )); @@ -319,9 +311,8 @@ class api_v3_ContributionTest extends CiviUnitTestCase { 'check_permissions' => false, 'financial_type_id' => 'Donation', ); - $contribution = civicrm_api('contribution', 'create', $params); - $this->assertAPISuccess($contribution, 'In line ' . __LINE__); - } + $contribution = $this->callAPISuccess('contribution', 'create', $params); + } /* * ensure we continue to support contribution_type_id as part of the api commitment to * stability @@ -336,16 +327,13 @@ class api_v3_ContributionTest extends CiviUnitTestCase { 'check_permissions' => false, 'contribution_type_id' => 3, ); - $contribution = civicrm_api('contribution', 'create', $params); - $this->assertAPISuccess($contribution, 'In line ' . __LINE__); + $contribution = $this->callAPISuccess('contribution', 'create', $params); $contribution = civicrm_api('contribution', 'getsingle', array('version' => $this->_apiversion, 'id' => $contribution['id'])); $this->assertEquals(3, $contribution['financial_type_id']); } ///////////////// civicrm_contribution_ function testCreateEmptyParamsContribution() { - - $params = array('version' => $this->_apiversion); $contribution = $this->callAPIFailure('contribution', 'create', $params); $this->assertEquals($contribution['error_message'], 'Mandatory key(s) missing from params array: financial_type_id, total_amount, contact_id', 'In line ' . __LINE__); @@ -376,11 +364,9 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $params = $this->_params; $params['custom_' . $ids['custom_field_id']] = "custom string"; - $result = civicrm_api($this->_entity, 'create', $params); + $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__); $this->assertEquals($result['id'], $result['values'][$result['id']]['id']); - $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertAPISuccess($result, ' in line ' . __LINE__); - $check = civicrm_api($this->_entity, 'get', array( + $check = $this->callAPISuccess($this->_entity, 'get', array( 'return.custom_' . $ids['custom_field_id'] => 1, 'version' => 3, 'id' => $result['id'], @@ -400,7 +386,7 @@ class api_v3_ContributionTest extends CiviUnitTestCase { function testCreateGetFieldsWithCustom() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ContactTest.php'); - $result = civicrm_api('Contribution', 'getfields', array('version' => 3)); + $result = $this->callAPISuccess('Contribution', 'getfields', array('version' => 3)); $this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']); $this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']); $this->customFieldDelete($ids['custom_field_id']); @@ -428,8 +414,8 @@ class api_v3_ContributionTest extends CiviUnitTestCase { 'skipLineItem' => 1, ); - $contribution = civicrm_api('contribution', 'create', $params); - $lineItems = civicrm_api('line_item','get',array( + $contribution = $this->callAPISuccess('contribution', 'create', $params); + $lineItems = $this->callAPISuccess('line_item','get',array( 'version' => $this->_apiversion, 'entity_id' => $contribution['id'], 'entity_table' => 'civicrm_contribution', @@ -473,12 +459,11 @@ class api_v3_ContributionTest extends CiviUnitTestCase { ), ); - $contribution = civicrm_api('contribution', 'create', $params); $description = "Create Contribution with Nested Line Items"; $subfile = "CreateWithNestedLineItems"; - $this->documentMe($params, $contribution, __FUNCTION__,__FILE__, $description, $subfile); - $this->assertAPISuccess($contribution, 'In line ' . __LINE__); - $lineItems = civicrm_api('line_item','get',array( + $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__,__FILE__, $description, $subfile); + + $lineItems = $this->callAPISuccess('line_item','get',array( 'version' => $this->_apiversion, 'entity_id' => $contribution['id'], 'entity_table' => 'civicrm_contribution', @@ -1261,13 +1246,13 @@ class api_v3_ContributionTest extends CiviUnitTestCase { 'contribution_status_id' => 2, 'version' => $this->_apiversion, ); - $contribution2 = civicrm_api('contribution', 'create', $p2); + $contribution2 = $this->callAPISuccess('contribution', 'create', $p2); $params = array( 'contribution_id' => $contribution2['id'], 'version' => $this->_apiversion, ); - $result = civicrm_api('contribution', 'get', $params); + $result = $this->callAPISuccess('contribution', 'get', $params); $res = $result['values'][$contribution2['id']]; $this->assertEquals($p2['contact_id'], $res['contact_id'], 'In line ' . __LINE__); @@ -1284,20 +1269,19 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $this->contributionDelete($contribution1['id']); $this->contributionDelete($contribution2['id']); } - /* + + /** * Test sending a mail via the API */ function testSendMail() { $mut = new CiviMailUtils( $this, true ); - $contribution = civicrm_api('contribution','create',$this->_params); - $this->assertAPISuccess($contribution); - $apiResult = civicrm_api('contribution', 'sendconfirmation', array( + $contribution = $this->callAPISuccess('contribution','create',$this->_params); + $apiResult = $this->callAPISuccess('contribution', 'sendconfirmation', array( 'version' => $this->_apiversion, 'id' => $contribution['id'], 'receipt_from_email' => 'api@civicrm.org', ) ); - $this->assertAPISuccess($apiResult); $mut->checkMailLog(array( '$ 100.00', 'Contribution Information', @@ -1309,13 +1293,13 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $mut->stop(); } - /* + /** * Test sending a mail via the API */ function testSendMailEvent() { $mut = new CiviMailUtils( $this, true ); - $contribution = civicrm_api('contribution','create',$this->_params); - $event = $this->eventCreate(array( + $contribution = $this->callAPISuccess('contribution','create',$this->_params); + $event = $this->eventCreate(array( 'is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org', )); @@ -1330,21 +1314,19 @@ class api_v3_ContributionTest extends CiviUnitTestCase { 'source' => 'Online Event Registration: API Testing', 'version' => $this->_apiversion, ); - $participant = civicrm_api('participant', 'create', $participantParams); - $this->assertAPISuccess($participant, "participant created in line " . __LINE__); - $this->assertAPISuccess(civicrm_api('participant_payment', 'create', array( + $participant = $this->callAPISuccess('participant', 'create', $participantParams); + $this->callAPISuccess('participant_payment', 'create', array( 'version' => 3, 'participant_id' => $participant['id'], 'contribution_id' => $contribution['id'], - )), " in line " . __LINE__); - $apiResult = civicrm_api('contribution', 'sendconfirmation', array( + )); + $apiResult = $this->callAPISuccess('contribution', 'sendconfirmation', array( 'version' => $this->_apiversion, 'id' => $contribution['id'], 'receipt_from_email' => 'api@civicrm.org', ) ); - $this->assertAPISuccess($apiResult); $mut->checkMailLog(array( 'Annual CiviCRM meet', 'Event', @@ -1358,7 +1340,6 @@ class api_v3_ContributionTest extends CiviUnitTestCase { /////////////// _civicrm_contribute_format_params for $create function testFormatParams() { - require_once 'CRM/Contribute/DAO/Contribution.php'; $params = array( 'contact_id' => $this->_individualId, 'receive_date' => date('Ymd'), -- 2.25.1