From 791c263cc4152fbd87f82fccbc1c1f2416e8d2d7 Mon Sep 17 00:00:00 2001 From: eileen Date: Thu, 13 Jun 2013 10:31:32 +1200 Subject: [PATCH] use api success & api failure & apiSetup for cleaner tests --- api/v3/examples/DomainCreate.php | 8 ++-- api/v3/examples/DomainGet.php | 20 ++++---- api/v3/examples/UFMatchGet.php | 8 ++-- tests/phpunit/CiviTest/CiviUnitTestCase.php | 15 ++++++ tests/phpunit/api/v3/APITest.php | 2 +- tests/phpunit/api/v3/ActivityTest.php | 2 +- tests/phpunit/api/v3/ActivityTypeTest.php | 4 +- tests/phpunit/api/v3/CRM11793Test.php | 2 +- tests/phpunit/api/v3/CaseTest.php | 8 ++-- tests/phpunit/api/v3/ContributionSoftTest.php | 4 +- tests/phpunit/api/v3/CustomFieldTest.php | 2 +- tests/phpunit/api/v3/DomainTest.php | 6 +-- tests/phpunit/api/v3/EntityTagTest.php | 16 +++---- tests/phpunit/api/v3/EventTest.php | 24 +++++----- tests/phpunit/api/v3/GroupContactTest.php | 4 +- tests/phpunit/api/v3/GroupNestingTest.php | 16 +++---- .../phpunit/api/v3/GroupOrganizationTest.php | 22 ++++----- tests/phpunit/api/v3/JobTest.php | 12 ++--- tests/phpunit/api/v3/MailingContactTest.php | 8 ++-- tests/phpunit/api/v3/MailingGroupTest.php | 8 ++-- tests/phpunit/api/v3/MailingTest.php | 8 ++-- tests/phpunit/api/v3/MembershipStatusTest.php | 22 ++++----- tests/phpunit/api/v3/MembershipTest.php | 34 +++++++------- tests/phpunit/api/v3/MembershipTypeTest.php | 2 +- tests/phpunit/api/v3/NoteTest.php | 22 ++++----- .../phpunit/api/v3/ParticipantPaymentTest.php | 4 +- tests/phpunit/api/v3/ParticipantTest.php | 8 ++-- tests/phpunit/api/v3/PaymentProcessorTest.php | 6 +-- tests/phpunit/api/v3/PledgeTest.php | 6 +-- tests/phpunit/api/v3/ProfileTest.php | 28 +++++------ tests/phpunit/api/v3/RelationshipTest.php | 46 +++++++++---------- tests/phpunit/api/v3/RelationshipTypeTest.php | 20 ++++---- tests/phpunit/api/v3/SurveyRespondantTest.php | 2 +- tests/phpunit/api/v3/UFFieldTest.php | 17 +++---- tests/phpunit/api/v3/UFGroupTest.php | 10 ++-- tests/phpunit/api/v3/UFJoinTest.php | 12 ++--- tests/phpunit/api/v3/UFMatchTest.php | 4 +- 37 files changed, 230 insertions(+), 212 deletions(-) diff --git a/api/v3/examples/DomainCreate.php b/api/v3/examples/DomainCreate.php index d681aaee2b..71316d270d 100644 --- a/api/v3/examples/DomainCreate.php +++ b/api/v3/examples/DomainCreate.php @@ -4,7 +4,7 @@ */ function domain_create_example(){ -$params = array( +$params = array( 'name' => 'A-team domain', 'description' => 'domain of chaos', 'version' => 3, @@ -22,13 +22,13 @@ $params = array( */ function domain_create_expectedresult(){ - $expectedResult = array( + $expectedResult = array( 'is_error' => 0, 'version' => 3, 'count' => 1, 'id' => 3, - 'values' => array( - '3' => array( + 'values' => array( + '3' => array( 'id' => '3', 'name' => 'A-team domain', 'description' => 'domain of chaos', diff --git a/api/v3/examples/DomainGet.php b/api/v3/examples/DomainGet.php index cd80d2b8ea..8fcfb516db 100644 --- a/api/v3/examples/DomainGet.php +++ b/api/v3/examples/DomainGet.php @@ -4,7 +4,7 @@ */ function domain_get_example(){ -$params = array( +$params = array( 'version' => 3, 'sequential' => 1, ); @@ -19,22 +19,23 @@ $params = array( */ function domain_get_expectedresult(){ - $expectedResult = array( + $expectedResult = array( 'is_error' => 0, 'version' => 3, 'count' => 2, - 'values' => array( - '0' => array( + 'values' => array( + '0' => array( 'id' => '1', 'name' => 'Default Domain Name', + 'config_backend' => 'a:79:{s:10:"userSystem";O:26:"CRM_Utils_System_UnitTests":4:{s:9:"is_drupal";b:0;s:9:"is_joomla";b:0;s:12:"is_wordpress";b:0;s:24:"supports_form_extensions";b:0;}s:11:"initialized";i:0;s:15:"DAOFactoryClass";s:23:"CRM_Contact_DAO_Factory";s:17:"componentRegistry";O:18:"CRM_Core_Component":0:{}s:9:"inCiviCRM";b:0;s:18:"recaptchaPublicKey";N;s:5:"debug";i:0;s:9:"backtrace";i:0;s:12:"resourceBase";N;s:13:"extensionsURL";N;s:12:"countryLimit";a:1:{i:0;s:4:"1228";}s:27:"defaultContactStateProvince";N;s:13:"provinceLimit";a:1:{i:0;s:4:"1228";}s:21:"defaultContactCountry";s:4:"1228";s:15:"defaultCurrency";s:3:"USD";s:10:"lcMessages";s:5:"en_US";s:18:"dateformatDatetime";s:20:"%B %E%f, %Y %l:%M %P";s:14:"dateformatFull";s:11:"%B %E%f, %Y";s:17:"dateformatPartial";s:5:"%B %Y";s:14:"dateformatYear";s:2:"%Y";s:14:"dateformatTime";s:8:"%l:%M %P";s:15:"timeInputFormat";i:1;s:15:"dateInputFormat";s:8:"mm/dd/yy";s:15:"fiscalYearStart";a:2:{s:1:"M";i:1;s:1:"d";i:1;}s:11:"moneyformat";s:5:"%c %a";s:16:"moneyvalueformat";s:3:"%!i";s:15:"currencySymbols";s:0:"";s:21:"defaultCurrencySymbol";s:1:"$";s:20:"monetaryDecimalPoint";s:1:".";s:25:"monetaryThousandSeparator";s:1:",";s:14:"gettextCodeset";s:5:"utf-8";s:13:"gettextDomain";s:7:"civicrm";s:27:"userFrameworkUsersTableName";s:5:"users";s:21:"userFrameworkFrontend";b:0;s:20:"userFrameworkLogging";b:0;s:17:"maxImportFileSize";i:1048576;s:11:"maxFileSize";i:2;s:11:"mapProvider";N;s:9:"mapAPIKey";N;s:11:"geoProvider";N;s:9:"geoAPIKey";N;s:13:"geocodeMethod";s:0:"";s:12:"mapGeoCoding";i:1;s:7:"logging";b:0;s:12:"versionCheck";b:1;s:16:"enableComponents";a:6:{i:0;s:14:"CiviContribute";i:1;s:10:"CiviPledge";i:2;s:10:"CiviMember";i:3;s:9:"CiviEvent";i:4;s:8:"CiviMail";i:5;s:10:"CiviReport";}s:18:"enableComponentIDs";a:6:{i:0;i:1;i:1;i:6;i:2;i:2;i:3;i:3;i:4;i:4;i:5;i:8;}s:9:"enableSSL";b:0;s:18:"fatalErrorTemplate";s:20:"CRM/common/fatal.tpl";s:17:"fatalErrorHandler";N;s:14:"legacyEncoding";s:12:"Windows-1252";s:14:"fieldSeparator";s:1:",";s:17:"maxLocationBlocks";i:2;s:15:"captchaFontPath";s:25:"/usr/X11R6/lib/X11/fonts/";s:11:"captchaFont";s:17:"HelveticaBold.ttf";s:21:"includeWildCardInName";i:1;s:18:"includeEmailInName";i:1;s:21:"includeNickNameInName";i:0;s:22:"smartGroupCacheTimeout";i:5;s:22:"defaultSearchProfileID";N;s:21:"dashboardCacheTimeout";i:1440;s:15:"doNotResetCache";i:0;s:24:"includeAlphabeticalPager";i:1;s:20:"includeOrderByClause";i:1;s:13:"oldInputStyle";i:1;s:14:"formKeyDisable";b:0;s:21:"doNotAttachPDFReceipt";b:0;s:15:"wkhtmltopdfPath";b:0;s:10:"wpBasePage";N;s:13:"verpSeparator";s:1:".";s:12:"mailerPeriod";i:180;s:16:"mailerSpoolLimit";i:0;s:16:"mailerBatchLimit";i:0;s:13:"mailerJobSize";i:0;s:13:"mailerJobsMax";i:0;s:16:"mailThrottleTime";i:0;s:12:"customCSSURL";N;s:15:"civiRelativeURL";s:13:"/index.php?q=";s:11:"civiVersion";s:10:"4.4.alpha1";}', 'version' => '3', 'contact_id' => '3', 'domain_email' => 'my@email.com', - 'domain_phone' => array( + 'domain_phone' => array( 'phone_type' => 'Phone', 'phone' => '456-456', ), - 'domain_address' => array( + 'domain_address' => array( 'street_address' => '45 Penny Lane', 'supplemental_address_1' => '', 'supplemental_address_2' => '', @@ -48,17 +49,18 @@ function domain_get_expectedresult(){ 'from_email' => 'info@EXAMPLE.ORG', 'from_name' => 'FIXME', ), - '1' => array( + '1' => array( 'id' => '2', 'name' => 'Second Domain', + 'config_backend' => 'a:79:{s:10:"userSystem";O:26:"CRM_Utils_System_UnitTests":4:{s:9:"is_drupal";b:0;s:9:"is_joomla";b:0;s:12:"is_wordpress";b:0;s:24:"supports_form_extensions";b:0;}s:11:"initialized";i:0;s:15:"DAOFactoryClass";s:23:"CRM_Contact_DAO_Factory";s:17:"componentRegistry";O:18:"CRM_Core_Component":0:{}s:9:"inCiviCRM";b:0;s:18:"recaptchaPublicKey";N;s:5:"debug";i:0;s:9:"backtrace";i:0;s:12:"resourceBase";N;s:13:"extensionsURL";N;s:12:"countryLimit";a:1:{i:0;s:4:"1228";}s:27:"defaultContactStateProvince";N;s:13:"provinceLimit";a:1:{i:0;s:4:"1228";}s:21:"defaultContactCountry";s:4:"1228";s:15:"defaultCurrency";s:3:"USD";s:10:"lcMessages";s:5:"en_US";s:18:"dateformatDatetime";s:20:"%B %E%f, %Y %l:%M %P";s:14:"dateformatFull";s:11:"%B %E%f, %Y";s:17:"dateformatPartial";s:5:"%B %Y";s:14:"dateformatYear";s:2:"%Y";s:14:"dateformatTime";s:8:"%l:%M %P";s:15:"timeInputFormat";i:1;s:15:"dateInputFormat";s:8:"mm/dd/yy";s:15:"fiscalYearStart";a:2:{s:1:"M";i:1;s:1:"d";i:1;}s:11:"moneyformat";s:5:"%c %a";s:16:"moneyvalueformat";s:3:"%!i";s:15:"currencySymbols";s:0:"";s:21:"defaultCurrencySymbol";s:1:"$";s:20:"monetaryDecimalPoint";s:1:".";s:25:"monetaryThousandSeparator";s:1:",";s:14:"gettextCodeset";s:5:"utf-8";s:13:"gettextDomain";s:7:"civicrm";s:27:"userFrameworkUsersTableName";s:5:"users";s:21:"userFrameworkFrontend";b:0;s:20:"userFrameworkLogging";b:0;s:17:"maxImportFileSize";i:1048576;s:11:"maxFileSize";i:2;s:11:"mapProvider";N;s:9:"mapAPIKey";N;s:11:"geoProvider";N;s:9:"geoAPIKey";N;s:13:"geocodeMethod";s:0:"";s:12:"mapGeoCoding";i:1;s:7:"logging";b:0;s:12:"versionCheck";b:1;s:16:"enableComponents";a:6:{i:0;s:14:"CiviContribute";i:1;s:10:"CiviPledge";i:2;s:10:"CiviMember";i:3;s:9:"CiviEvent";i:4;s:8:"CiviMail";i:5;s:10:"CiviReport";}s:18:"enableComponentIDs";a:6:{i:0;i:1;i:1;i:6;i:2;i:2;i:3;i:3;i:4;i:4;i:5;i:8;}s:9:"enableSSL";b:0;s:18:"fatalErrorTemplate";s:20:"CRM/common/fatal.tpl";s:17:"fatalErrorHandler";N;s:14:"legacyEncoding";s:12:"Windows-1252";s:14:"fieldSeparator";s:1:",";s:17:"maxLocationBlocks";i:2;s:15:"captchaFontPath";s:25:"/usr/X11R6/lib/X11/fonts/";s:11:"captchaFont";s:17:"HelveticaBold.ttf";s:21:"includeWildCardInName";i:1;s:18:"includeEmailInName";i:1;s:21:"includeNickNameInName";i:0;s:22:"smartGroupCacheTimeout";i:5;s:22:"defaultSearchProfileID";N;s:21:"dashboardCacheTimeout";i:1440;s:15:"doNotResetCache";i:0;s:24:"includeAlphabeticalPager";i:1;s:20:"includeOrderByClause";i:1;s:13:"oldInputStyle";i:1;s:14:"formKeyDisable";b:0;s:21:"doNotAttachPDFReceipt";b:0;s:15:"wkhtmltopdfPath";b:0;s:10:"wpBasePage";N;s:13:"verpSeparator";s:1:".";s:12:"mailerPeriod";i:180;s:16:"mailerSpoolLimit";i:0;s:16:"mailerBatchLimit";i:0;s:13:"mailerJobSize";i:0;s:13:"mailerJobsMax";i:0;s:16:"mailThrottleTime";i:0;s:12:"customCSSURL";N;s:15:"civiRelativeURL";s:13:"/index.php?q=";s:11:"civiVersion";s:10:"4.4.alpha1";}', 'version' => '4.3.alpha1', 'contact_id' => '2', 'domain_email' => '"Domain Email" ', - 'domain_phone' => array( + 'domain_phone' => array( 'phone_type' => 'Phone', 'phone' => '204 555-1001', ), - 'domain_address' => array( + 'domain_address' => array( 'street_address' => '15 Main St', 'supplemental_address_1' => '', 'supplemental_address_2' => '', diff --git a/api/v3/examples/UFMatchGet.php b/api/v3/examples/UFMatchGet.php index 2a34f210bf..852b15c6c7 100644 --- a/api/v3/examples/UFMatchGet.php +++ b/api/v3/examples/UFMatchGet.php @@ -4,7 +4,7 @@ */ function uf_match_get_example(){ -$params = array( +$params = array( 'contact_id' => 69, 'version' => 3, ); @@ -19,13 +19,13 @@ $params = array( */ function uf_match_get_expectedresult(){ - $expectedResult = array( + $expectedResult = array( 'is_error' => 0, 'version' => 3, 'count' => 1, 'id' => 1, - 'values' => array( - '1' => array( + 'values' => array( + '1' => array( 'id' => '1', 'domain_id' => '1', 'uf_id' => '42', diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 51ab302fb2..624b3125af 100644 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -623,6 +623,21 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { function assertType($expected, $actual, $message = '') { return $this->assertInternalType($expected, $actual, $message); } + /** + * This function exists to wrap api functions used to set up tests but not part of the test + * so we can ensure they succeed & throw exceptions without litterering the test with checks + * @param string $entity + * @param string $action + * @param array $params + */ + function apiSetup($entity, $action, $params){ + if(!isset($params['version'])){ + $params['version'] = API_LATEST_VERSION; + } + $result = civicrm_api($entity, $action, $params); + $this->assertAPISuccess($result, "Failure in test setup for $entity $action"); + return $result; + } /** * Generic function to create Organisation, to be used in test cases * diff --git a/tests/phpunit/api/v3/APITest.php b/tests/phpunit/api/v3/APITest.php index 763a6d8489..8706c268f2 100644 --- a/tests/phpunit/api/v3/APITest.php +++ b/tests/phpunit/api/v3/APITest.php @@ -96,7 +96,7 @@ class api_v3_APITest extends CiviUnitTestCase { $result = civicrm_api('RandomFile', 'get', array('version' => 3)); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'API (RandomFile,get) does not exist (join the API team and implement it!)'); } diff --git a/tests/phpunit/api/v3/ActivityTest.php b/tests/phpunit/api/v3/ActivityTest.php index 699b919d9a..aaa228798e 100644 --- a/tests/phpunit/api/v3/ActivityTest.php +++ b/tests/phpunit/api/v3/ActivityTest.php @@ -212,7 +212,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { $result = civicrm_api('activity', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } diff --git a/tests/phpunit/api/v3/ActivityTypeTest.php b/tests/phpunit/api/v3/ActivityTypeTest.php index 8177795e3a..a2dc892dc1 100644 --- a/tests/phpunit/api/v3/ActivityTypeTest.php +++ b/tests/phpunit/api/v3/ActivityTypeTest.php @@ -78,7 +78,7 @@ class api_v3_ActivityTypeTest extends CiviUnitTestCase { ); $result = civicrm_api('activity_type', 'create', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } /** @@ -115,7 +115,7 @@ class api_v3_ActivityTypeTest extends CiviUnitTestCase { ); $result = civicrm_api('activity_type', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); } } diff --git a/tests/phpunit/api/v3/CRM11793Test.php b/tests/phpunit/api/v3/CRM11793Test.php index 43ad375889..f7f01be0db 100644 --- a/tests/phpunit/api/v3/CRM11793Test.php +++ b/tests/phpunit/api/v3/CRM11793Test.php @@ -69,7 +69,7 @@ class api_v3_CRM11793Test extends CiviUnitTestCase { ) ); - $this->assertEquals($result['is_error'], 0, "In line " . __LINE__); + $this->assertAPISuccess($result, "In line " . __LINE__); foreach ($result['values'] as $idx => $contact) { $this->assertEquals($contact['contact_type'], $contactType, "In line " . __LINE__); } diff --git a/tests/phpunit/api/v3/CaseTest.php b/tests/phpunit/api/v3/CaseTest.php index b87b280760..5ce11baef6 100644 --- a/tests/phpunit/api/v3/CaseTest.php +++ b/tests/phpunit/api/v3/CaseTest.php @@ -252,7 +252,7 @@ class api_v3_CaseTest extends CiviUnitTestCase { function testCaseCreateEmpty() { $params = array('version' => $this->_apiversion); $result = civicrm_api('case', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -268,7 +268,7 @@ class api_v3_CaseTest extends CiviUnitTestCase { ); $result = civicrm_api('case', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -439,7 +439,7 @@ class api_v3_CaseTest extends CiviUnitTestCase { ); $result = civicrm_api('activity', 'create', $params); - $this->assertEquals($result['is_error'], 0, + $this->assertAPISuccess($result, "Error message: " . CRM_Utils_Array::value('error_message', $result) . ' in line ' . __LINE__ ); $this->assertEquals($result['values'][$result['id']]['subject'], $params['subject'], 'in line ' . __LINE__); @@ -494,7 +494,7 @@ class api_v3_CaseTest extends CiviUnitTestCase { ); $result = civicrm_api('activity', 'create', $params); - $this->assertEquals($result['is_error'], 0, + $this->assertAPISuccess($result, "Error message: " . CRM_Utils_Array::value('error_message', $result) . ' in line ' . __LINE__ ); diff --git a/tests/phpunit/api/v3/ContributionSoftTest.php b/tests/phpunit/api/v3/ContributionSoftTest.php index aa9b986be1..999db71c46 100644 --- a/tests/phpunit/api/v3/ContributionSoftTest.php +++ b/tests/phpunit/api/v3/ContributionSoftTest.php @@ -406,7 +406,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase { ); $result = civicrm_api('contribution_soft', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0, 'In line ' . __LINE__); + $this->assertAPISuccess($result, 'In line ' . __LINE__); } ///////////////// civicrm_contribution_search methods @@ -418,7 +418,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('contribution_soft', 'get', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array', 'In line ' . __LINE__); } diff --git a/tests/phpunit/api/v3/CustomFieldTest.php b/tests/phpunit/api/v3/CustomFieldTest.php index 4d46010dc1..922c742a47 100644 --- a/tests/phpunit/api/v3/CustomFieldTest.php +++ b/tests/phpunit/api/v3/CustomFieldTest.php @@ -395,7 +395,7 @@ class api_v3_CustomFieldTest extends CiviUnitTestCase { $result = civicrm_api('custom_field', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); } /** diff --git a/tests/phpunit/api/v3/DomainTest.php b/tests/phpunit/api/v3/DomainTest.php index 38be19a34a..deaf5de817 100644 --- a/tests/phpunit/api/v3/DomainTest.php +++ b/tests/phpunit/api/v3/DomainTest.php @@ -198,7 +198,7 @@ class api_v3_DomainTest extends CiviUnitTestCase { public function testCreate() { $result = civicrm_api('domain', 'create', $this->params); $this->documentMe($this->params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['count'], 1); $this->assertNotNull($result['id']); $this->assertEquals($result['values'][$result['id']]['name'], $this->params['name']); @@ -212,7 +212,7 @@ class api_v3_DomainTest extends CiviUnitTestCase { public function testCreateWithEmptyParams() { $params = array('version' => $this->_apiversion); $result = civicrm_api('domain', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -223,7 +223,7 @@ class api_v3_DomainTest extends CiviUnitTestCase { public function testCreateWithWrongParams() { $params = 1; $result = civicrm_api('domain', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } diff --git a/tests/phpunit/api/v3/EntityTagTest.php b/tests/phpunit/api/v3/EntityTagTest.php index b3062ebe93..a023b4bd48 100644 --- a/tests/phpunit/api/v3/EntityTagTest.php +++ b/tests/phpunit/api/v3/EntityTagTest.php @@ -98,7 +98,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { $result = civicrm_api('entity_tag', 'create', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['added'], 1); } @@ -114,7 +114,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { $result = civicrm_api('entity_tag', 'create', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['added'], 1); $params = array( @@ -125,7 +125,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { ); $result = civicrm_api('entity_tag', 'create', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['added'], 1); $this->assertEquals($result['not_added'], 1); } @@ -246,7 +246,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { ); $result = civicrm_api('entity_tag', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'tag_id is a required field'); } @@ -268,7 +268,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { $result = civicrm_api('entity_tag', 'delete', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['removed'], 2); } @@ -392,7 +392,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { ); $result = _civicrm_api3_entity_tag_common($params, 'remove'); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'contact_id is a required field'); } @@ -412,7 +412,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { ); $result = _civicrm_api3_entity_tag_common($params, 'remove'); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'tag_id is a required field'); } @@ -434,7 +434,7 @@ class api_v3_EntityTagTest extends CiviUnitTestCase { $result = _civicrm_api3_entity_tag_common($params, 'remove'); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['removed'], 2); } diff --git a/tests/phpunit/api/v3/EventTest.php b/tests/phpunit/api/v3/EventTest.php index a0da50f008..e19d567264 100644 --- a/tests/phpunit/api/v3/EventTest.php +++ b/tests/phpunit/api/v3/EventTest.php @@ -133,14 +133,14 @@ class api_v3_EventTest extends CiviUnitTestCase { $params = 'Annual CiviCRM meet'; $result = civicrm_api('Event', 'Get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testGetEventEmptyParams() { $params = array(); $result = civicrm_api('event', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testGetEventById() { @@ -353,31 +353,31 @@ class api_v3_EventTest extends CiviUnitTestCase { function testCreateEventEmptyParams() { $params = array(); $result = civicrm_api('event', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testCreateEventParamsWithoutTitle() { unset($this->_params['title']); $result = civicrm_api('event', 'create', $this->_params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testCreateEventParamsWithoutEventTypeId() { unset($this->_params['event_type_id']); $result = civicrm_api('event', 'create', $this->_params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testCreateEventParamsWithoutStartDate() { unset($this->_params['start_date']); $result = civicrm_api('event', 'create', $this->_params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testCreateEventSuccess() { $result = civicrm_api('Event', 'Create', $this->_params[0]); $this->documentMe($this->_params[0], $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertArrayHasKey('id', $result['values'][$result['id']], 'In line ' . __LINE__); $result = civicrm_api($this->_entity, 'Get', array('version' => 3, 'id' => $result['id'])); civicrm_api($this->_entity, 'Delete', array('version' => 3, 'id' => $result['id'])); @@ -414,7 +414,7 @@ class api_v3_EventTest extends CiviUnitTestCase { function testUpdateEvent() { $result = civicrm_api('event', 'create', $this->_params[1]); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $params = array( 'id' => $result['id'], 'version' => 3, 'max_participants' => 150, ); @@ -432,13 +432,13 @@ class api_v3_EventTest extends CiviUnitTestCase { $params = 'Annual CiviCRM meet'; $result = civicrm_api('Event', 'Delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testDeleteEmptyParams() { $params = array(); $result = civicrm_api('Event', 'Delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testDelete() { @@ -482,7 +482,7 @@ class api_v3_EventTest extends CiviUnitTestCase { // try to delete again - there's no such event anymore $params = array('event_id' => $this->_eventIds[0]); $result = civicrm_api('Event', 'Delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } ///////////////// civicrm_event_search methods @@ -494,7 +494,7 @@ class api_v3_EventTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('event', 'get', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); } /** diff --git a/tests/phpunit/api/v3/GroupContactTest.php b/tests/phpunit/api/v3/GroupContactTest.php index 022020f33e..ce9908da40 100644 --- a/tests/phpunit/api/v3/GroupContactTest.php +++ b/tests/phpunit/api/v3/GroupContactTest.php @@ -202,7 +202,7 @@ class api_v3_GroupContactTest extends CiviUnitTestCase { $result = civicrm_api('group_contact', 'create', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals($result['not_added'], 1, "in line " . __LINE__); $this->assertEquals($result['added'], 1, "in line " . __LINE__); $this->assertEquals($result['total_count'], 2, "in line " . __LINE__); @@ -218,7 +218,7 @@ class api_v3_GroupContactTest extends CiviUnitTestCase { $result = civicrm_api('group_contact', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals($result['removed'], 1, "in line " . __LINE__); $this->assertEquals($result['total_count'], 1, "in line " . __LINE__); } diff --git a/tests/phpunit/api/v3/GroupNestingTest.php b/tests/phpunit/api/v3/GroupNestingTest.php index bce492cfd5..c8ede33184 100644 --- a/tests/phpunit/api/v3/GroupNestingTest.php +++ b/tests/phpunit/api/v3/GroupNestingTest.php @@ -193,7 +193,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { ); $result = civicrm_api('group_nesting', 'get', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -206,7 +206,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { $params = array(); $result = civicrm_api('group_nesting', 'get', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -219,7 +219,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('group_nesting', 'get', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -239,7 +239,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { $result = civicrm_api('group_nesting', 'create', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); // we have 4 group nesting records in the example // data, expecting next number to be the id for newly created @@ -256,7 +256,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { $params = array(); $result = civicrm_api('group_nesting', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -269,7 +269,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('group_nesting', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -303,7 +303,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { $params = array(); $result = civicrm_api('group_nesting', 'delete', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -316,7 +316,7 @@ class api_v3_GroupNestingTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('group_nesting', 'delete', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } diff --git a/tests/phpunit/api/v3/GroupOrganizationTest.php b/tests/phpunit/api/v3/GroupOrganizationTest.php index 71b5ec38f2..ede6851d90 100644 --- a/tests/phpunit/api/v3/GroupOrganizationTest.php +++ b/tests/phpunit/api/v3/GroupOrganizationTest.php @@ -99,7 +99,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ); $result = civicrm_api('group_organization', 'get', $paramsGet); $this->documentMe($paramsGet, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } /** @@ -118,7 +118,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { $paramsGet = array('organization_id' => $result['values'][0]['organization_id']); $result = civicrm_api('group_organization', 'get', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } /** @@ -130,7 +130,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ); $result = civicrm_api('group_organization', 'get', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } /** @@ -140,7 +140,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { $params = 'groupOrg'; $result = civicrm_api('group_organization', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); } @@ -154,7 +154,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ); $result = civicrm_api('group_organization', 'get', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } ///////////////// civicrm_group_organization_create methods @@ -182,7 +182,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ); $result = civicrm_api('group_organization', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: group_id, organization_id'); } @@ -193,7 +193,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { $params = 'group_org'; $result = civicrm_api('group_organization', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); } @@ -207,7 +207,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ); $result = civicrm_api('group_organization', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: group_id, organization_id'); } @@ -220,7 +220,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { $params = 'delete'; $result = civicrm_api('group_organization', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); } @@ -233,7 +233,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ); $result = civicrm_api('group_organization', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: id'); } @@ -267,7 +267,7 @@ class api_v3_GroupOrganizationTest extends CiviUnitTestCase { ); $result = civicrm_api('group_organization', 'delete', $paramsDelete); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: id'); } } diff --git a/tests/phpunit/api/v3/JobTest.php b/tests/phpunit/api/v3/JobTest.php index 3b73eaa5ce..4619550c4b 100644 --- a/tests/phpunit/api/v3/JobTest.php +++ b/tests/phpunit/api/v3/JobTest.php @@ -65,7 +65,7 @@ class api_v3_JobTest extends CiviUnitTestCase { ); $result = civicrm_api('job', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: run_frequency, name, api_entity, api_action' ); @@ -87,7 +87,7 @@ class api_v3_JobTest extends CiviUnitTestCase { 'is_active' => 1, ); $result = civicrm_api('job', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -123,7 +123,7 @@ class api_v3_JobTest extends CiviUnitTestCase { function testDeleteEmpty() { $params = array(); $result = civicrm_api('job', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -131,7 +131,7 @@ class api_v3_JobTest extends CiviUnitTestCase { */ function testDeleteParamsNotArray() { $result = civicrm_api('job', 'delete', 'string'); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -145,7 +145,7 @@ class api_v3_JobTest extends CiviUnitTestCase { ); $result = civicrm_api('job', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: version, id'); } @@ -160,7 +160,7 @@ class api_v3_JobTest extends CiviUnitTestCase { $result = civicrm_api('job', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Invalid value for job ID'); } diff --git a/tests/phpunit/api/v3/MailingContactTest.php b/tests/phpunit/api/v3/MailingContactTest.php index 9317f20ca1..91ca72b6b3 100644 --- a/tests/phpunit/api/v3/MailingContactTest.php +++ b/tests/phpunit/api/v3/MailingContactTest.php @@ -76,7 +76,7 @@ class api_v3_MailingContactTest extends CiviUnitTestCase { public function testMailingNullParams() { $result = civicrm_api('MailingContact', 'get', null); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } public function testMailingContactGetFields() { $result = civicrm_api('MailingContact', 'getfields', array( @@ -100,7 +100,7 @@ class api_v3_MailingContactTest extends CiviUnitTestCase { ); $result = civicrm_api('MailingContact', 'get', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } /* @@ -113,7 +113,7 @@ class api_v3_MailingContactTest extends CiviUnitTestCase { ); $result = civicrm_api('MailingContact', 'get', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } /* @@ -127,7 +127,7 @@ class api_v3_MailingContactTest extends CiviUnitTestCase { ); $result = civicrm_api('MailingContact', 'get', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } diff --git a/tests/phpunit/api/v3/MailingGroupTest.php b/tests/phpunit/api/v3/MailingGroupTest.php index 4587d1e108..649f86e714 100644 --- a/tests/phpunit/api/v3/MailingGroupTest.php +++ b/tests/phpunit/api/v3/MailingGroupTest.php @@ -71,7 +71,7 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { 'hash' => 'sasa', ); $result = civicrm_api('mailing_event_subscribe', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); if ($result['error_message'] != 'Subscription failed') { $this->assertEquals($result['error_message'], 'Invalid Group id', 'In line ' . __LINE__); } @@ -124,7 +124,7 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { ); $result = civicrm_api('mailing_event_unsubscribe', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Queue event could not be found', 'In line ' . __LINE__); } @@ -144,7 +144,7 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { ); $result = civicrm_api('mailing_event_unsubscribe', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Domain Queue event could not be found', 'In line ' . __LINE__); } @@ -168,7 +168,7 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { 'time_stamp' => '20101212121212', ); $result = civicrm_api('mailing_event_resubscribe', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Queue event could not be found', 'In line ' . __LINE__); } diff --git a/tests/phpunit/api/v3/MailingTest.php b/tests/phpunit/api/v3/MailingTest.php index e36855c7f0..f60fc83811 100644 --- a/tests/phpunit/api/v3/MailingTest.php +++ b/tests/phpunit/api/v3/MailingTest.php @@ -94,7 +94,7 @@ class api_v3_MailingTest extends CiviUnitTestCase { 'time_stamp' => '20111109212100', ); $result = civicrm_api('mailing_event', 'bounce', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Queue event could not be found', 'In line ' . __LINE__); } @@ -113,7 +113,7 @@ class api_v3_MailingTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('mailing_event', 'confirm', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Confirmation failed', 'In line ' . __LINE__); } @@ -133,7 +133,7 @@ class api_v3_MailingTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('mailing_event', 'reply', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Queue event could not be found', 'In line ' . __LINE__); } @@ -153,7 +153,7 @@ class api_v3_MailingTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('mailing_event', 'forward', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Queue event could not be found', 'In line ' . __LINE__); } diff --git a/tests/phpunit/api/v3/MembershipStatusTest.php b/tests/phpunit/api/v3/MembershipStatusTest.php index 45cff3e3c2..e3be7f2d4e 100644 --- a/tests/phpunit/api/v3/MembershipStatusTest.php +++ b/tests/phpunit/api/v3/MembershipStatusTest.php @@ -70,7 +70,7 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('membership_status', 'get', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array', 'In line ' . __LINE__); } @@ -124,13 +124,13 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { function testCreateWithEmptyParams() { $params = array(); $result = civicrm_api('membership_status', 'create', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } function testCreateWithWrongParamsType() { $params = 'a string'; $result = civicrm_api('membership_status', 'create', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); $params = array('version' =>3, 'id' => 'string'); $result = civicrm_api('membership_status', 'create', $params); } @@ -147,7 +147,7 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { function testCreateWithMissingRequired() { $params = array('title' => 'Does not make sense'); $result = civicrm_api('membership_status', 'create', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } function testCreate() { @@ -158,7 +158,7 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { $result = civicrm_api('membership_status', 'create', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertNotNull($result['id']); $this->membershipStatusDelete($result['id']); } @@ -238,19 +238,19 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { function testDeleteEmptyParams() { $params = array(); $result = civicrm_api('membership_status', 'delete', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } function testDeleteWrongParamsType() { $params = 'incorrect value'; $result = civicrm_api('membership_status', 'delete', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } function testDeleteWithMissingRequired() { $params = array('title' => 'Does not make sense'); $result = civicrm_api('membership_status', 'delete', $params); - $this->assertEquals($result['is_error'], 1, "In line " . __LINE__); + $this->assertAPIFailure($result, "In line " . __LINE__); } function testDelete() { @@ -260,7 +260,7 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { 'version' => $this->_apiversion, ); $result = civicrm_api('membership_status', 'delete', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } /* * Test that trying to delete membership status while membership still exists creates error @@ -289,7 +289,7 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { 'version' => $this->_apiversion, ); $result = civicrm_api('membership_status', 'delete', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); civicrm_api('Membership', 'Delete', array( 'id' => $membershipID, @@ -297,7 +297,7 @@ class api_v3_MembershipStatusTest extends CiviUnitTestCase { )); $result = civicrm_api('membership_status', 'delete', $params); - $this->assertEquals($result['is_error'], 0, 'In line ' . __LINE__); + $this->assertAPISuccess($result, 'In line ' . __LINE__); } } diff --git a/tests/phpunit/api/v3/MembershipTest.php b/tests/phpunit/api/v3/MembershipTest.php index 1cd2d809f3..cb086b169a 100644 --- a/tests/phpunit/api/v3/MembershipTest.php +++ b/tests/phpunit/api/v3/MembershipTest.php @@ -100,13 +100,13 @@ class api_v3_MembershipTest extends CiviUnitTestCase { function testMembershipDeleteEmpty() { $params = array(); $result = civicrm_api('membership', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testMembershipDeleteInvalidID() { $params = array('version' => $this->_apiversion, 'id' => 'blah'); $result = civicrm_api('membership', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -115,7 +115,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { function testMembershipDeleteWithInvalidMembershipId() { $membershipId = 'membership'; $result = civicrm_api('membership', 'delete', $membershipId); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -207,7 +207,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { 'version' => $this->_apiversion, )); - $this->assertEquals($result['is_error'], 0, "In line " . __LINE__); + $this->assertAPISuccess($result, "In line " . __LINE__); $this->assertEquals($result['count'], 0, "In line " . __LINE__); civicrm_api('Membership', 'Delete', array( 'id' => $this->_membershipID, @@ -435,7 +435,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { function testCreateWithEmptyParams() { $params = array(); $result = civicrm_api('membership', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -445,7 +445,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { function testCreateWithParamsString() { $params = 'a string'; $result = civicrm_api('membership', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -456,7 +456,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { $params = $this->_params; unset($params['status_id']); $result = civicrm_api('membership', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -473,7 +473,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { ); $result = civicrm_api('membership', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testMembershipCreate() { @@ -492,7 +492,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { $result = civicrm_api('membership', 'create', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); $this->getAndCheck($params, $result['id'], $this->_entity); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertNotNull($result['id']); $this->assertEquals($this->_contactID, $result['values'][$result['id']]['contact_id'], " in line " . __LINE__); $this->assertEquals($result['id'], $result['values'][$result['id']]['id'], " in line " . __LINE__); @@ -583,7 +583,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { 'id' => $result['id'], 'version' => $this->_apiversion, )); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals($result['id'], $membershipID, "in line " . __LINE__); } @@ -612,7 +612,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { 'id' => $result['id'], 'version' => $this->_apiversion, )); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals($result['id'], $membershipID, "in line " . __LINE__); } @@ -638,7 +638,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { 'id' => $result['id'], 'version' => $this->_apiversion, )); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals($result['id'], $membershipID, "in line " . __LINE__); } @@ -663,7 +663,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { 'id' => $result['id'], 'version' => $this->_apiversion, )); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals($result['id'], $membershipID, "in line " . __LINE__); } @@ -684,7 +684,7 @@ class api_v3_MembershipTest extends CiviUnitTestCase { 'skipStatusCal' => 1, ); $result = civicrm_api('membership', 'create', $params); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals($result['id'], $membershipID, "in line " . __LINE__); civicrm_api('Membership', 'Delete', array( 'id' => $result['id'], @@ -737,18 +737,18 @@ class api_v3_MembershipTest extends CiviUnitTestCase { ); $result = civicrm_api('membership', 'create', $params); - $this->assertEquals($result['is_error'], 1, "in line " . __LINE__); + $this->assertAPIFailure($result, "in line " . __LINE__); //membership_contact_id which is no in contact table $params['membership_contact_id'] = 999; $result = civicrm_api('membership', 'create', $params); - $this->assertEquals($result['is_error'], 1, "in line " . __LINE__); + $this->assertAPIFailure($result, "in line " . __LINE__); //invalid join date unset($params['membership_contact_id']); $params['join_date'] = "invalid"; $result = civicrm_api('Membership', 'Create', $params); - $this->assertEquals($result['is_error'], 1, "in line " . __LINE__); + $this->assertAPIFailure($result, "in line " . __LINE__); } /** diff --git a/tests/phpunit/api/v3/MembershipTypeTest.php b/tests/phpunit/api/v3/MembershipTypeTest.php index ce05024459..9b6619c30a 100644 --- a/tests/phpunit/api/v3/MembershipTypeTest.php +++ b/tests/phpunit/api/v3/MembershipTypeTest.php @@ -361,7 +361,7 @@ class api_v3_MembershipTypeTest extends CiviUnitTestCase { $result = civicrm_api('membership_type', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } } diff --git a/tests/phpunit/api/v3/NoteTest.php b/tests/phpunit/api/v3/NoteTest.php index d6903eee87..5d451a6f50 100644 --- a/tests/phpunit/api/v3/NoteTest.php +++ b/tests/phpunit/api/v3/NoteTest.php @@ -90,7 +90,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { function testGetWithWrongParamsType() { $params = 'a string'; $result = civicrm_api('note', 'get', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -130,7 +130,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { ); $result = civicrm_api3_note_get($params); $this->documentMe($this->_params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); } @@ -143,7 +143,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { function testCreateWithWrongParamsType() { $params = 'a string'; $result = civicrm_api('note', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); @@ -156,7 +156,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { function testCreateWithEmptyNoteField() { $this->_params['note'] = ""; $result = civicrm_api('note', 'create', $this->_params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: note'); } @@ -167,7 +167,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { function testCreateWithoutEntityId() { unset($this->_params['entity_id']); $result = civicrm_api('note', 'create', $this->_params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: entity_id'); } @@ -178,7 +178,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { function testCreateWithEmptyEntityId() { $this->_params['entity_id'] = ""; $result = civicrm_api('note', 'create', $this->_params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: entity_id'); } @@ -193,7 +193,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { $this->assertEquals(date('Y-m-d', strtotime($this->_params['modified_date'])), date('Y-m-d', strtotime($result['values'][$result['id']]['modified_date'])), 'in line ' . __LINE__); $this->assertArrayHasKey('id', $result, 'in line ' . __LINE__); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); $note = array( 'id' => $result['id'], 'version' => $this->_apiversion, @@ -213,7 +213,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { 'version' => $this->_apiversion, ); $result = civicrm_api('Note', 'Create', $params); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); $this->assertEquals($result['values'][0]['note'], "Hello!!! ' testing Note", 'in line ' . __LINE__); $this->assertEquals($result['values'][0]['subject'], "With a '", 'in line ' . __LINE__); $this->assertArrayHasKey('id', $result, 'in line ' . __LINE__); @@ -250,7 +250,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { function testUpdateWithWrongParamsType() { $params = 'a string'; $result = civicrm_api('note', 'create', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -312,7 +312,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { function testDeleteWithWrongParamsType() { $params = 'a string'; $result = civicrm_api('note', 'delete', $params); - $this->assertEquals($result['is_error'], 1, + $this->assertAPIFailure($result, "In line " . __LINE__ ); } @@ -356,7 +356,7 @@ class api_v3_NoteTest extends CiviUnitTestCase { $result = civicrm_api('note', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); } } diff --git a/tests/phpunit/api/v3/ParticipantPaymentTest.php b/tests/phpunit/api/v3/ParticipantPaymentTest.php index ce1b9e2adb..2ea76fb993 100644 --- a/tests/phpunit/api/v3/ParticipantPaymentTest.php +++ b/tests/phpunit/api/v3/ParticipantPaymentTest.php @@ -147,7 +147,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { $result = civicrm_api('participant_payment', 'create', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); $this->assertTrue(array_key_exists('id', $result), 'in line ' . __LINE__); //delete created contribution @@ -360,7 +360,7 @@ class api_v3_ParticipantPaymentTest extends CiviUnitTestCase { $result = civicrm_api('participant_payment', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } ///////////////// civicrm_participantPayment_get methods diff --git a/tests/phpunit/api/v3/ParticipantTest.php b/tests/phpunit/api/v3/ParticipantTest.php index df332aa450..8027e3da64 100644 --- a/tests/phpunit/api/v3/ParticipantTest.php +++ b/tests/phpunit/api/v3/ParticipantTest.php @@ -180,7 +180,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ); $result = civicrm_api('participant', 'get', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['values'][$this->_participantID]['event_id'], $this->_eventID); $this->assertEquals($result['values'][$this->_participantID]['participant_register_date'], '2007-02-19 00:00:00'); $this->assertEquals($result['values'][$this->_participantID]['participant_source'], 'Wimbeldon'); @@ -205,7 +205,7 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ); $result = civicrm_api('participant', 'get', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__, $description, $subfile); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['values'][$this->_participantID]['event_id'], $this->_eventID); $this->assertEquals($result['values'][$this->_participantID]['participant_register_date'], '2007-02-19 00:00:00'); $this->assertEquals($result['values'][$this->_participantID]['participant_source'], 'Wimbeldon'); @@ -785,13 +785,13 @@ class api_v3_ParticipantTest extends CiviUnitTestCase { ); $result = civicrm_api('participant','get', $params); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->assertEquals($result['count'], 3); $params['participant_role_id'] =2; $result = civicrm_api('participant','get', $params); - $this->assertEquals($result['is_error'], 0, "in line " . __LINE__); + $this->assertAPISuccess($result, "in line " . __LINE__); $this->assertEquals(2,$result['count'], "in line " . __LINE__); $this->documentMe($params,$result ,__FUNCTION__,__FILE__); } diff --git a/tests/phpunit/api/v3/PaymentProcessorTest.php b/tests/phpunit/api/v3/PaymentProcessorTest.php index 4f79205213..77b6611c2a 100644 --- a/tests/phpunit/api/v3/PaymentProcessorTest.php +++ b/tests/phpunit/api/v3/PaymentProcessorTest.php @@ -90,7 +90,7 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { ); $result = civicrm_api('payment_processor', 'create', $payProcParams); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -117,7 +117,7 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { require_once 'api/v3/examples/PaymentProcessorCreate.php'; $result = payment_processor_create_example(); $expectedResult = payment_processor_create_expectedresult(); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } ///////////////// civicrm_payment_processor_delete methods @@ -135,7 +135,7 @@ class api_v3_PaymentProcessorTest extends CiviUnitTestCase { $result = civicrm_api('payment_processor', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } ///////////////// civicrm_payment_processors_get methods diff --git a/tests/phpunit/api/v3/PledgeTest.php b/tests/phpunit/api/v3/PledgeTest.php index b35623ed6d..3b59cf66ec 100644 --- a/tests/phpunit/api/v3/PledgeTest.php +++ b/tests/phpunit/api/v3/PledgeTest.php @@ -266,7 +266,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { $this->assertEquals($result['values'][0]['status_id'], 2, 'In line ' . __LINE__); $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000', 'In line ' . __LINE__); $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000', 'In line ' . __LINE__); - $this->assertEquals($result['is_error'], 0, 'In line ' . __LINE__); + $this->assertAPISuccess($result, 'In line ' . __LINE__); $payments = civicrm_api('PledgePayment', 'Get', array('version' => 3, 'pledge_id' => $result['id'], 'sequential' => 1)); $this->assertAPISuccess($payments, 'In line ' . __LINE__); $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__); @@ -540,7 +540,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { ); $result = civicrm_api('pledge', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } /* @@ -555,7 +555,7 @@ class api_v3_PledgeTest extends CiviUnitTestCase { ); $result = civicrm_api('pledge', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } /* * test to make sure empty get returns nothing diff --git a/tests/phpunit/api/v3/ProfileTest.php b/tests/phpunit/api/v3/ProfileTest.php index 6a8c12c1ea..9955920a67 100644 --- a/tests/phpunit/api/v3/ProfileTest.php +++ b/tests/phpunit/api/v3/ProfileTest.php @@ -78,7 +78,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('profile', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: profile_id'); } @@ -92,7 +92,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('profile', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -131,7 +131,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { unset($params['activity_id']); $result = civicrm_api('profile', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: activity_id'); } @@ -144,7 +144,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $params['activity_id'] = 100001; $result = civicrm_api('profile', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Invalid Activity Id (aid).'); $this->quickCleanup(array('civicrm_uf_field', 'civicrm_uf_join', 'civicrm_uf_group', 'civicrm_custom_field', 'civicrm_custom_group', 'civicrm_contact')); @@ -183,7 +183,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $params['activity_id'] = $activityValues['id']; $result = civicrm_api('profile', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'This activity cannot be edited or viewed via this profile.'); $this->quickCleanup(array('civicrm_uf_field', 'civicrm_uf_join', 'civicrm_uf_group', 'civicrm_custom_field', 'civicrm_custom_group', 'civicrm_contact')); @@ -216,7 +216,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { function testProfileSetNoArray() { $params = NULL; $result = civicrm_api('profile', 'set', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); } @@ -229,7 +229,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('profile', 'set', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: profile_id'); } @@ -243,7 +243,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('profile', 'set', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -267,7 +267,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $result = civicrm_api('profile', 'set', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Missing required parameters for profile id 25: email-Primary'); $this->quickCleanup(array('civicrm_uf_field', 'civicrm_uf_join', 'civicrm_uf_group', 'civicrm_contact')); @@ -327,7 +327,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { unset($params['activity_id']); $result = civicrm_api('profile', 'set', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: activity_id'); $this->quickCleanup(array('civicrm_uf_field', 'civicrm_uf_join', 'civicrm_uf_group', 'civicrm_custom_field', 'civicrm_custom_group', 'civicrm_contact')); @@ -343,7 +343,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $params['activity_id'] = 100001; $result = civicrm_api('profile', 'set', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Invalid Activity Id (aid).'); $this->quickCleanup(array('civicrm_uf_field', 'civicrm_uf_join', 'civicrm_uf_group', 'civicrm_custom_field', 'civicrm_custom_group', 'civicrm_contact')); @@ -383,7 +383,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { $params['activity_id'] = $activityValues['id']; $result = civicrm_api('profile', 'set', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'This activity cannot be edited or viewed via this profile.'); $this->quickCleanup(array('civicrm_uf_field', 'civicrm_uf_join', 'civicrm_uf_group', 'civicrm_custom_field', 'civicrm_custom_group', 'civicrm_contact')); @@ -439,7 +439,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('profile', 'apply', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: profile_id'); } @@ -453,7 +453,7 @@ class api_v3_ProfileTest extends CiviUnitTestCase { 'version' => 3, ); $result = civicrm_api('profile', 'apply', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** diff --git a/tests/phpunit/api/v3/RelationshipTest.php b/tests/phpunit/api/v3/RelationshipTest.php index 1f34d39b4e..4b34a51d2c 100644 --- a/tests/phpunit/api/v3/RelationshipTest.php +++ b/tests/phpunit/api/v3/RelationshipTest.php @@ -96,7 +96,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { function testRelationshipCreateEmpty() { $params = array('version' => $this->_apiversion); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -105,7 +105,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { function testRelationshipCreateParamsNotArray() { $params = 'relationship_type_id = 5'; $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -119,7 +119,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -135,7 +135,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); //contact id is not an integer $params = array( @@ -146,18 +146,18 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { 'is_active' => 1, ); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); //contact id does not exists $params['contact_id_a'] = 999; $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); //invalid date $params['contact_id_a'] = $this->_cId_a; $params['start_date'] = array('d' => '1', 'M' => '1'); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -175,7 +175,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); // both the contact of type Organization $params = array( @@ -188,7 +188,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -215,7 +215,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Relationship already exists'); $params['id'] = $relationship['id']; @@ -538,7 +538,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { function testRelationshipDeleteEmpty() { $params = array('version' => $this->_apiversion); $result = civicrm_api('relationship', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: id'); } @@ -548,7 +548,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { function testRelationshipDeleteParamsNotArray() { $params = 'relationship_type_id = 5'; $result = civicrm_api('relationship', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); } @@ -563,7 +563,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: version, id'); } @@ -579,12 +579,12 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'delete', $params); - $this->assertEquals($result['is_error'], 1, 'in line ' . __LINE__); + $this->assertAPIFailure($result, 'in line ' . __LINE__); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: id', 'in line ' . __LINE__); $params['id'] = "Invalid"; $result = civicrm_api('relationship', 'delete', $params); - $this->assertEquals($result['is_error'], 1, 'in line ' . __LINE__); + $this->assertAPIFailure($result, 'in line ' . __LINE__); $this->assertEquals($result['error_message'], 'Invalid value for relationship ID', 'in line ' . __LINE__); } @@ -621,7 +621,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { function testRelationshipUpdateEmpty() { $params = array('version' => 3); $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals('Mandatory key(s) missing from params array: contact_id_a, contact_id_b, relationship_type_id', $result['error_message'], 'In line ' . __LINE__); } @@ -631,7 +631,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { function testRelationshipUpdateParamsNotArray() { $params = 'relationship_type_id = 5'; $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals('Input variable `params` is not an array', $result['error_message'], 'In line ' . __LINE__); } @@ -669,7 +669,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { $result = civicrm_api('relationship', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Relationship already exists', 'In line ' . __LINE__); //delete created relationship @@ -679,7 +679,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'delete', $params); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); //delete created relationship type $this->relationshipTypeDelete($this->_relTypeID); @@ -904,7 +904,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { 'version' => $this->_apiversion, ); $result = civicrm_api('relationship_type', 'create', $relTypeParams); - $this->assertEquals($result['is_error'], 1, 'in line ' . __LINE__); + $this->assertAPIFailure($result, 'in line ' . __LINE__); $this->assertEquals($result['error_message'], 'Invalid value for relationship type ID', 'in line ' . __LINE__); } @@ -919,7 +919,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { //no relationship has been created $result = civicrm_api('relationship', 'get', $contact_a, $contact_b, NULL, 'asc'); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -944,7 +944,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship', 'get', $contacts); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); $this->assertGreaterThan(0, $result['count'], 'in line ' . __LINE__); $params = array( 'id' => $relationship['id'], @@ -977,7 +977,7 @@ class api_v3_RelationshipTest extends CiviUnitTestCase { $result = civicrm_api('relationship', 'get', $contact_a); - $this->assertEquals($result['is_error'], 0, 'in line ' . __LINE__); + $this->assertAPISuccess($result, 'in line ' . __LINE__); $params = array( 'id' => $relationship['id'], diff --git a/tests/phpunit/api/v3/RelationshipTypeTest.php b/tests/phpunit/api/v3/RelationshipTypeTest.php index c5ae72ac50..79adf832cd 100644 --- a/tests/phpunit/api/v3/RelationshipTypeTest.php +++ b/tests/phpunit/api/v3/RelationshipTypeTest.php @@ -102,7 +102,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship_type', 'create', $relTypeParams); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: name_a_b, name_b_a' ); @@ -119,7 +119,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship_type', 'create', $relTypeParams); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: contact_type_a, contact_type_b' ); @@ -155,7 +155,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { require_once 'api/v3/examples/RelationshipTypeCreate.php'; $result = relationship_type_create_example(); $expectedResult = relationship_type_create_expectedresult(); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } ///////////////// civicrm_relationship_type_delete methods @@ -167,7 +167,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { $params = array(); $result = civicrm_api('relationship_type', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -177,7 +177,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { $params = 'name_a_b = Test1'; $result = civicrm_api('relationship_type', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -193,7 +193,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { $result = civicrm_api('relationship_type', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: version, id'); } @@ -214,7 +214,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { $result = civicrm_api('relationship_type', 'delete', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Invalid value for relationship type ID'); } @@ -230,7 +230,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { ); $result = civicrm_api('relationship_type', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); } ///////////////// civicrm_relationship_type_update @@ -242,7 +242,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { $params = array(); $result = civicrm_api('relationship_type', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: version, name_a_b, name_b_a, contact_type_a, contact_type_b'); } @@ -253,7 +253,7 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase { $params = 'name_a_b = Relation 1'; $result = civicrm_api('relationship_type', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); } diff --git a/tests/phpunit/api/v3/SurveyRespondantTest.php b/tests/phpunit/api/v3/SurveyRespondantTest.php index ef625282cb..7d1bceed1a 100644 --- a/tests/phpunit/api/v3/SurveyRespondantTest.php +++ b/tests/phpunit/api/v3/SurveyRespondantTest.php @@ -76,7 +76,7 @@ class api_v3_SurveyRespondantTest extends CiviUnitTestCase { */ public function testGetSurveyRespondants() { $result = civicrm_api("SurveyRespondant","get", $this->params ); - $this->assertEquals($result['is_error'], 0); + $this->assertAPISuccess($result); $this->documentMe($this->params, $result, __FUNCTION__, __FILE__); $this->assertAPISuccess($result, 'In line ' . __LINE__); } diff --git a/tests/phpunit/api/v3/UFFieldTest.php b/tests/phpunit/api/v3/UFFieldTest.php index 1f06871334..814d73151d 100644 --- a/tests/phpunit/api/v3/UFFieldTest.php +++ b/tests/phpunit/api/v3/UFFieldTest.php @@ -102,8 +102,8 @@ class api_v3_UFFieldTest extends CiviUnitTestCase { $this->documentMe($params, $ufField, __FUNCTION__, __FILE__); unset($params['version']); unset($params['uf_group_id']); + $this->assertAPISuccess($ufField, " in line " . __LINE__); $this->_ufFieldId = $ufField['id']; - $this->assertEquals(0, $ufField['is_error'], " in line " . __LINE__); foreach ($params as $key => $value) { $this->assertEquals($ufField['values'][$ufField['id']][$key], $params[$key]); } @@ -113,22 +113,22 @@ class api_v3_UFFieldTest extends CiviUnitTestCase { $params = $this->_params; // copy $params['field_name'] = 'custom_98789'; // invalid field $result = civicrm_api('uf_field', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testCreateUFFieldWithEmptyParams() { $params = array(); $result = civicrm_api('uf_field', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testCreateUFFieldWithWrongParams() { $result = civicrm_api('uf_field', 'create', array('field_name' => 'test field')); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $result = civicrm_api('uf_field', 'create', 'a string'); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $result = civicrm_api('uf_field', 'create', array('label' => 'name-less field')); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** * Create a field with 'weight=1' and then a second with 'weight=1'. The second field @@ -137,6 +137,7 @@ class api_v3_UFFieldTest extends CiviUnitTestCase { public function testCreateUFFieldWithDefaultAutoWeight() { $params1 = $this->_params; // copy $ufField1 = civicrm_api('uf_field', 'create', $params1); + $this->assertAPISuccess($ufField1, " in line " . __LINE__); $this->assertEquals(1, $ufField1['values'][$ufField1['id']]['weight']); $this->assertDBQuery(1, 'SELECT weight FROM civicrm_uf_field WHERE id = %1', array( 1 => array($ufField1['id'], 'Int'), @@ -173,11 +174,11 @@ class api_v3_UFFieldTest extends CiviUnitTestCase { public function testGetUFFieldSuccess() { - civicrm_api($this->_entity, 'create', $this->_params); + $this->apiSetup($this->_entity, 'create', $this->_params); $params = array('version' => 3); $result = civicrm_api($this->_entity, 'get', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); - $this->assertAPISuccess($result, 0, 'in line' . __LINE__); + $this->assertAPISuccess($result, 'in line' . __LINE__); $this->getAndCheck($this->_params, $result['id'], $this->_entity); } diff --git a/tests/phpunit/api/v3/UFGroupTest.php b/tests/phpunit/api/v3/UFGroupTest.php index 46e2ffa2a2..ad2f7961a7 100644 --- a/tests/phpunit/api/v3/UFGroupTest.php +++ b/tests/phpunit/api/v3/UFGroupTest.php @@ -194,9 +194,9 @@ class api_v3_UFGroupTest extends CiviUnitTestCase { function testUFGroupCreateWithWrongParams() { $result = civicrm_api('uf_group', 'create', 'a string'); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $result = civicrm_api('uf_group', 'create', array('name' => 'A title-less group')); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testUFGroupUpdate() { @@ -266,14 +266,14 @@ class api_v3_UFGroupTest extends CiviUnitTestCase { function testUFGroupUpdateWithEmptyParams() { $result = civicrm_api('uf_group', 'create', array(), $this->_ufGroupId); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testUFGroupUpdateWithWrongParams() { $result = civicrm_api('uf_group', 'create', 'a string', $this->_ufGroupId); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $result = civicrm_api('uf_group', 'create', array('title' => 'Title'), 'a string'); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } function testUFGroupDelete() { diff --git a/tests/phpunit/api/v3/UFJoinTest.php b/tests/phpunit/api/v3/UFJoinTest.php index b716add824..2b9898fefa 100644 --- a/tests/phpunit/api/v3/UFJoinTest.php +++ b/tests/phpunit/api/v3/UFJoinTest.php @@ -156,7 +156,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('uf_join', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array', 'In line ' . __LINE__); } @@ -164,7 +164,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { $params = array(); $result = civicrm_api('uf_join', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: version, module, weight, uf_group_id', 'In line ' . __LINE__); } @@ -178,7 +178,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { 'version' => $this->_apiversion, ); $result = civicrm_api('uf_join', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: uf_group_id', 'In line ' . __LINE__); } @@ -224,7 +224,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { $params = 'a string'; $result = civicrm_api('uf_join', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Input variable `params` is not an array', 'In line ' . __LINE__); } @@ -232,7 +232,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { $params = array(); $result = civicrm_api('uf_join', 'create', $params); - $this->assertEquals($result['is_error'], 1, 'In line ' . __LINE__); + $this->assertAPIFailure($result, 'In line ' . __LINE__); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: version, module, weight, uf_group_id', 'In line ' . __LINE__); } @@ -247,7 +247,7 @@ class api_v3_UFJoinTest extends CiviUnitTestCase { ); $result = civicrm_api('uf_join', 'create', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: uf_group_id', 'In line ' . __LINE__); } diff --git a/tests/phpunit/api/v3/UFMatchTest.php b/tests/phpunit/api/v3/UFMatchTest.php index c86882246f..29d71ec55d 100644 --- a/tests/phpunit/api/v3/UFMatchTest.php +++ b/tests/phpunit/api/v3/UFMatchTest.php @@ -104,7 +104,7 @@ class api_v3_UFMatchTest extends CiviUnitTestCase { function testGetUFMatchIDWrongParam() { $params = 'a string'; $result = civicrm_api('uf_match', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** @@ -124,7 +124,7 @@ class api_v3_UFMatchTest extends CiviUnitTestCase { function testGetUFIDWrongParam() { $params = 'a string'; $result = civicrm_api('uf_match', 'get', $params); - $this->assertEquals($result['is_error'], 1); + $this->assertAPIFailure($result); } /** -- 2.25.1