Skip to content

Commit

Permalink
Test Cleanup - Refactor out uses of deprecated callAPIAndDocument()
Browse files Browse the repository at this point in the history
  • Loading branch information
@colemanw
colemanw committed Aug 25, 2023
1 parent bde6db9 commit 2ed04f4
Show file tree
Hide file tree
Showing 77 changed files with 340 additions and 502 deletions.
4 changes: 2 additions & 2 deletions tests/phpunit/CiviTest/CiviUnitTestCase.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3432,7 +3432,7 @@ protected function createRuleGroup() {
*/
protected function basicCreateTest(int $version): void {
$this->_apiversion = $version;
$result = $this->callAPIAndDocument($this->_entity, 'create', $this->params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess($this->_entity, 'create', $this->params);
$this->assertEquals(1, $result['count']);
$this->assertNotNull($result['values'][$result['id']]['id']);
$this->getAndCheck($this->params, $result['id'], $this->_entity);
Expand All @@ -3449,7 +3449,7 @@ protected function basicDeleteTest(int $version): void {
$this->_apiversion = $version;
$result = $this->callAPISuccess($this->_entity, 'create', $this->params);
$deleteParams = ['id' => $result['id']];
$this->callAPIAndDocument($this->_entity, 'delete', $deleteParams, __FUNCTION__, __FILE__);
$this->callAPISuccess($this->_entity, 'delete', $deleteParams);
$checkDeleted = $this->callAPISuccess($this->_entity, 'get', []);
$this->assertEquals(0, $checkDeleted['count']);
}
Expand Down
12 changes: 6 additions & 6 deletions tests/phpunit/api/v3/ActivityCaseTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,21 +108,21 @@ public function testGet() {
$this->assertTrue(is_numeric($this->_case['id']));
$this->assertTrue(is_numeric($this->_otherActivity['id']));

$getByCaseId = $this->callAPIAndDocument('Activity', 'get', [
$getByCaseId = $this->callAPISuccess('Activity', 'get', [
'case_id' => $this->_case['id'],
], __FUNCTION__, __FILE__);
]);
$this->assertNotEmpty($getByCaseId['values']);
$getByCaseId_ids = array_keys($getByCaseId['values']);

$getByCaseNotNull = $this->callAPIAndDocument('Activity', 'get', [
$getByCaseNotNull = $this->callAPISuccess('Activity', 'get', [
'case_id' => ['IS NOT NULL' => 1],
], __FUNCTION__, __FILE__);
]);
$this->assertNotEmpty($getByCaseNotNull['values']);
$getByCaseNotNull_ids = array_keys($getByCaseNotNull['values']);

$getByCaseNull = $this->callAPIAndDocument('Activity', 'get', [
$getByCaseNull = $this->callAPISuccess('Activity', 'get', [
'case_id' => ['IS NULL' => 1],
], __FUNCTION__, __FILE__);
]);
$this->assertNotEmpty($getByCaseNull['values']);
$getByCaseNull_ids = array_keys($getByCaseNull['values']);

Expand Down
6 changes: 3 additions & 3 deletions tests/phpunit/api/v3/ActivityContactTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ public function setUp(): void {
public function testCreateActivityContact($version) {
$this->_apiversion = $version;

$result = $this->callAPIAndDocument('ActivityContact', 'create', $this->_params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('ActivityContact', 'create', $this->_params);
$this->assertEquals(1, $result['count']);
$this->assertNotNull($result['values'][$result['id']]['id']);

$result = $this->callAPIAndDocument('ActivityContact', 'create', $this->_params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('ActivityContact', 'create', $this->_params);
$this->assertEquals(1, $result['count']);

$this->callAPISuccess('activity_contact', 'delete', ['id' => $result['id']]);
Expand All @@ -68,7 +68,7 @@ public function testDeleteActivityContact($version) {
//create one
$create = $this->callAPISuccess('activity_contact', 'create', $this->_params);

$result = $this->callAPIAndDocument('activity_contact', 'delete', ['id' => $create['id']], __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('activity_contact', 'delete', ['id' => $create['id']]);
$this->assertEquals(1, $result['count']);
$get = $this->callAPISuccess('activity_contact', 'get', [
'id' => $create['id'],
Expand Down
40 changes: 14 additions & 26 deletions tests/phpunit/api/v3/ActivityTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,8 +377,6 @@ public function testActivityCreateCampaignTypeID(int $version): void {
*/
public function testActivityReturnTargetAssignee(int $version): void {
$this->_apiversion = $version;
$description = 'Demonstrates setting & retrieving activity target & source.';
$subfile = 'GetTargetAndAssignee';
$params = [
'source_contact_id' => $this->_contactID,
'subject' => 'Make-it-Happen Meeting',
Expand All @@ -393,7 +391,7 @@ public function testActivityReturnTargetAssignee(int $version): void {
'assignee_contact_id' => $this->_contactID,
];

$result = $this->callAPIAndDocument('activity', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
$result = $this->callAPISuccess('activity', 'create', $params);

$actContacts = $this->callAPISuccess('ActivityContact', 'get', [
'activity_id' => $result['id'],
Expand All @@ -419,8 +417,6 @@ public function testActivityReturnTargetAssignee(int $version): void {
*/
public function testActivityReturnTargetAssigneeName() {

$description = "Demonstrates retrieving activity target & source contact names.";
$subfile = "GetTargetandAssigneeName";
$target1 = $this->callAPISuccess('Contact', 'create', ['contact_type' => 'Individual', 'first_name' => 'A', 'last_name' => 'Cat']);
$target2 = $this->callAPISuccess('Contact', 'create', ['contact_type' => 'Individual', 'first_name' => 'B', 'last_name' => 'Good']);
$assignee = $this->callAPISuccess('Contact', 'create', ['contact_type' => 'Individual', 'first_name' => 'C', 'last_name' => 'Shore']);
Expand All @@ -437,10 +433,10 @@ public function testActivityReturnTargetAssigneeName() {
];

$result = $this->callAPISuccess('activity', 'create', $params);
$result = $this->callAPIAndDocument('activity', 'getsingle', [
$result = $this->callAPISuccess('activity', 'getsingle', [
'id' => $result['id'],
'return' => ['source_contact_name', 'target_contact_name', 'assignee_contact_name', 'subject'],
], __FUNCTION__, __FILE__, $description, $subfile);
]);

$this->assertEquals($params['subject'], $result['subject']);
$this->assertEquals($source['id'], $result['source_contact_id']);
Expand All @@ -458,7 +454,7 @@ public function testActivityCreateCustom() {
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
$params = $this->_params;
$params['custom_' . $ids['custom_field_id']] = "custom string";
$result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess($this->_entity, 'create', $params);
$result = $this->callAPISuccess($this->_entity, 'get', [
'return.custom_' . $ids['custom_field_id'] => 1,
'id' => $result['id'],
Expand All @@ -482,7 +478,7 @@ public function testActivityCreateCustomSubType() {
]);
$params = $this->_params;
$params['custom_' . $ids['custom_field_id']] = "custom string";
$result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess($this->_entity, 'create', $params);
$result = $this->callAPISuccess($this->_entity, 'get', [
'return.custom_' . $ids['custom_field_id'] => 1,
'id' => $result['id'],
Expand All @@ -499,8 +495,6 @@ public function testActivityCreateCustomSubType() {
public function testActivityCreateCustomContactRefField() {

$this->callAPISuccess('contact', 'create', ['id' => $this->_contactID, 'sort_name' => 'Contact, Test']);
$subfile = 'ContactRefCustomField';
$description = "Demonstrates create with Contact Reference Custom Field.";
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
$params = [
'custom_group_id' => $ids['custom_group_id'],
Expand All @@ -517,11 +511,11 @@ public function testActivityCreateCustomContactRefField() {
$params = $this->_params;
$params['custom_' . $customField['id']] = "$this->_contactID";

$result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
$result = $this->callAPIAndDocument($this->_entity, 'get', [
$result = $this->callAPISuccess($this->_entity, 'create', $params);
$result = $this->callAPISuccess($this->_entity, 'get', [
'return.custom_' . $customField['id'] => 1,
'id' => $result['id'],
], __FUNCTION__, __FILE__, 'Get with Contact Ref Custom Field', 'ContactRefCustomFieldGet');
]);

$this->assertEquals('Anderson, Anthony', $result['values'][$result['id']]['custom_' . $customField['id']]);
$this->assertEquals($this->_contactID, $result['values'][$result['id']]['custom_' . $customField['id'] . "_id"], ' in line ' . __LINE__);
Expand Down Expand Up @@ -606,8 +600,6 @@ public function testActivityGetEmpty() {
*/
public function testActivityGetGoodID1() {
// Insert rows in civicrm_activity creating activities 4 and 13
$description = 'Demonstrates getting assignee_contact_id & using it to get the contact.';
$subfile = 'ReturnAssigneeContact';
$activity = $this->callAPISuccess('activity', 'create', $this->_params);

$contact = $this->callAPISuccess('Contact', 'Create', [
Expand All @@ -632,7 +624,7 @@ public function testActivityGetGoodID1() {
'return' => ['activity_type_id', 'subject'],
];

$result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
$result = $this->callAPISuccess('Activity', 'Get', $params);

$this->assertEquals($activity['id'], $result['id']);

Expand Down Expand Up @@ -851,19 +843,15 @@ public function testGetFilterMaxDate(): void {
$result = $this->callAPISuccess('Activity', 'Get', [
'version' => 3,
]);
$description = "Demonstrates _low filter (at time of writing doesn't work if contact_id is set.";
$subFile = "DateTimeLow";
$this->assertEquals(2, $result['count']);
$params = [
'version' => 3,
'filter.activity_date_time_low' => '20120101000000',
'sequential' => 1,
'return' => 'activity_date_time',
];
$result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subFile);
$result = $this->callAPISuccess('Activity', 'Get', $params);
$this->assertEquals(1, $result['count']);
$description = "Demonstrates _high filter (at time of writing doesn't work if contact_id is set.";
$subFile = 'DateTimeHigh';
$this->assertEquals('2012-02-16 00:00:00', $result['values'][0]['activity_date_time']);
$params = [
'source_contact_id' => $this->_contactID,
Expand All @@ -872,7 +860,7 @@ public function testGetFilterMaxDate(): void {
'sequential' => 1,
'return' => 'activity_date_time',
];
$result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subFile);
$result = $this->callAPISuccess('Activity', 'Get', $params);

$this->assertEquals(1, $result['count']);
$this->assertEquals('2011-01-01 00:00:00', $result['values'][0]['activity_date_time']);
Expand All @@ -899,7 +887,7 @@ public function testActivityGetGoodIDCustom() {
'sequential' => 1,
'return.custom_' . $ids['custom_field_id'] => 1,
];
$result = $this->callAPIAndDocument('activity', 'get', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('activity', 'get', $params);
$this->assertEquals('custom string', $result['values'][0]['custom_' . $ids['custom_field_id']]);
$this->customFieldDelete($ids['custom_field_id']);
$this->customGroupDelete($ids['custom_group_id']);
Expand Down Expand Up @@ -947,7 +935,7 @@ public function testDeleteActivityWithInvalidID(): void {
public function testDeleteActivity(): void {
$result = $this->callAPISuccess('Activity', 'create', $this->_params);
$params = ['id' => $result['id']];
$this->callAPIAndDocument('Activity', 'delete', $params, __FUNCTION__, __FILE__);
$this->callAPISuccess('Activity', 'delete', $params);
}

/**
Expand Down Expand Up @@ -1344,7 +1332,7 @@ public function testActivitiesContactGetHavingNoActivity() {
*/
public function testGetFields() {
$params = ['action' => 'create'];
$result = $this->callAPIAndDocument('activity', 'getfields', $params, __FUNCTION__, __FILE__, NULL, NULL);
$result = $this->callAPISuccess('activity', 'getfields', $params);
$this->assertTrue(is_array($result['values']), 'get fields doesn\'t return values array');
foreach ($result['values'] as $key => $value) {
$this->assertTrue(is_array($value), $key . " is not an array");
Expand Down
4 changes: 2 additions & 2 deletions tests/phpunit/api/v3/ActivityTypeTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public function setUp(): void {
*/
public function testActivityTypeGet() {
$params = [];
$result = $this->callAPIAndDocument('activity_type', 'get', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('activity_type', 'get', $params);
$this->assertEquals($result['values']['1'], 'Meeting');
}

Expand All @@ -62,7 +62,7 @@ public function testActivityTypeCreate() {
'is_optgroup' => 1,
'is_default' => 0,
];
$result = $this->callAPIAndDocument('activity_type', 'create', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('activity_type', 'create', $params);
}

/**
Expand Down
20 changes: 7 additions & 13 deletions tests/phpunit/api/v3/AddressTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public function tearDown(): void {
*/
public function testCreateAddress($version) {
$this->_apiversion = $version;
$result = $this->callAPIAndDocument('Address', 'create', $this->_params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('Address', 'create', $this->_params);
$this->assertEquals(1, $result['count']);
$this->assertNotNull($result['values'][$result['id']]['id']);
$this->getAndCheck($this->_params, $result['id'], 'address');
Expand All @@ -82,9 +82,7 @@ public function testCreateAddressParsing($version) {
'location_type_id' => $this->_locationTypeID,
'contact_id' => $this->_contactID,
];
$subfile = "AddressParse";
$description = "Demonstrates Use of address parsing param.";
$result = $this->callAPIAndDocument('address', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
$result = $this->callAPISuccess('address', 'create', $params);
$this->assertEquals(54, $result['values'][$result['id']]['street_number']);
$this->assertEquals('A', $result['values'][$result['id']]['street_number_suffix']);
$this->assertEquals('Excelsior Ave.', $result['values'][$result['id']]['street_name']);
Expand Down Expand Up @@ -119,7 +117,7 @@ public function testCreateAddressDefaultLocation($version) {
$this->_apiversion = $version;
$params = $this->_params;
unset($params['location_type_id']);
$result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess($this->_entity, 'create', $params);
$this->assertEquals(CRM_Core_BAO_LocationType::getDefault()->id, $result['values'][$result['id']]['location_type_id']);
$this->callAPISuccess($this->_entity, 'delete', ['id' => $result['id']]);
}
Expand Down Expand Up @@ -270,7 +268,7 @@ public function testDeleteAddress($version): void {
//create one
$create = $this->callAPISuccess('address', 'create', $this->_params);

$result = $this->callAPIAndDocument('address', 'delete', ['id' => $create['id']], __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('address', 'delete', ['id' => $create['id']]);
$this->assertEquals(1, $result['count']);
$get = $this->callAPISuccess('address', 'get', [
'location_type_id' => $this->_locationTypeID,
Expand All @@ -292,7 +290,7 @@ public function testGetAddress($version) {
'street_name' => $address['values'][$address['id']]['street_name'],
'return' => ['location_type_id', 'is_primary', 'street_address'],
];
$result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('Address', 'Get', $params);
$this->assertEquals($address['values'][$address['id']]['location_type_id'], $result['values'][$address['id']]['location_type_id']);
$this->assertEquals($address['values'][$address['id']]['is_primary'], $result['values'][$address['id']]['is_primary']);
$this->assertEquals($address['values'][$address['id']]['street_address'], $result['values'][$address['id']]['street_address']);
Expand Down Expand Up @@ -323,8 +321,6 @@ public function testGetAddressSort($version) {
$this->_apiversion = $version;
$create = $this->callAPISuccess('address', 'create', $this->_params);
$this->callAPISuccess('address', 'create', array_merge($this->_params, ['street_address' => 'yzy']));
$subfile = "AddressSort";
$description = 'Demonstrates Use of sort filter.';
$params = [
'options' => [
'sort' => 'street_address DESC',
Expand All @@ -333,7 +329,7 @@ public function testGetAddressSort($version) {
'sequential' => 1,
'return' => 'street_address',
];
$result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
$result = $this->callAPISuccess('Address', 'Get', $params);
$this->assertEquals(2, $result['count']);
$this->assertEquals('Ambachtstraat 23', $result['values'][1]['street_address']);
}
Expand All @@ -346,14 +342,12 @@ public function testGetAddressSort($version) {
public function testGetAddressLikeSuccess($version) {
$this->_apiversion = $version;
$this->callAPISuccess('address', 'create', $this->_params);
$subfile = 'AddressLike';
$description = 'Demonstrates Use of Like.';
$params = [
'street_address' => ['LIKE' => '%mb%'],
'sequential' => 1,
'return' => 'street_address',
];
$result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
$result = $this->callAPISuccess('Address', 'Get', $params);
$this->assertEquals(1, $result['count']);
$this->assertEquals('Ambachtstraat 23', $result['values'][0]['street_address']);
}
Expand Down
8 changes: 4 additions & 4 deletions tests/phpunit/api/v3/BatchTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public function testGet(int $version): void {
$params = [
'id' => $this->batchCreate(),
];
$result = $this->callAPIAndDocument('Batch', 'get', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('Batch', 'get', $params);
$this->assertEquals($params['id'], $result['id']);
}

Expand All @@ -65,7 +65,7 @@ public function testCreate(int $version): void {
'status_id' => 1,
];

$result = $this->callAPIAndDocument('batch', 'create', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('batch', 'create', $params);
$this->assertNotNull($result['id']);
$this->getAndCheck($params, $result['id'], 'Batch');
}
Expand All @@ -90,7 +90,7 @@ public function testUpdate(int $version): void {
'id' => $this->batchCreate(),
];

$result = $this->callAPIAndDocument('batch', 'create', $params, __FUNCTION__, __FILE__);
$result = $this->callAPISuccess('batch', 'create', $params);
$this->assertNotNull($result['id']);
$this->getAndCheck($params, $result['id'], $this->_entity);
}
Expand Down Expand Up @@ -121,7 +121,7 @@ public function testBatchDeleteCorrectSyntax(int $version): void {
$params = [
'id' => $batchID,
];
$this->callAPIAndDocument('Batch', 'delete', $params, __FUNCTION__, __FILE__);
$this->callAPISuccess('Batch', 'delete', $params);
}

}
Loading

0 comments on commit 2ed04f4

Please sign in to comment.