Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(REF) Tidy up unused params in api_v3_ContributionSoftTest #25322

Merged
merged 2 commits into from
Feb 17, 2023
Merged

(REF) Tidy up unused params in api_v3_ContributionSoftTest #25322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
766a306
(REF) Tidy up unused params in api_v3_ContributionSoftTest
braders Jan 11, 2023
9f73e72
Improve capitalisation of softContribution variables
braders Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 58 additions & 70 deletions tests/phpunit/api/v3/ContributionSoftTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,6 @@ public function setUp(): void {
'source' => 'SSF',
'contribution_status_id' => 1,
];
$this->_processorParams = [
'domain_id' => 1,
'name' => 'Dummy',
'payment_processor_type_id' => 10,
'financial_account_id' => 12,
'is_active' => 1,
'user_name' => '',
'url_site' => 'http://dummy.com',
'url_recur' => 'http://dummy.com',
'billing_mode' => 1,
];
}

/**
Expand All @@ -94,40 +83,39 @@ public function testGetContributionSoft() {
'soft_credit_type_id' => 4,
];

$this->_softcontribution = $this->callAPISuccess('contribution_soft', 'create', $p);
$softContribution = $this->callAPISuccess('contribution_soft', 'create', $p);
$params = [
'id' => $this->_softcontribution['id'],
'id' => $softContribution['id'],
];
$softcontribution = $this->callAPIAndDocument('contribution_soft', 'get', $params, __FUNCTION__, __FILE__);
$this->assertEquals(1, $softcontribution['count']);
$this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['contribution_id'], $this->_contributionId);
$this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['contact_id'], $this->_softIndividual1Id);
$this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['amount'], '10.00');
$this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['currency'], 'USD');
$this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['soft_credit_type_id'], 4);
$softContribution = $this->callAPIAndDocument('contribution_soft', 'get', $params, __FUNCTION__, __FILE__);
$this->assertEquals(1, $softContribution['count']);
$this->assertEquals($softContribution['values'][$softContribution['id']]['contribution_id'], $this->_contributionId);
$this->assertEquals($softContribution['values'][$softContribution['id']]['contact_id'], $this->_softIndividual1Id);
$this->assertEquals($softContribution['values'][$softContribution['id']]['amount'], '10.00');
$this->assertEquals($softContribution['values'][$softContribution['id']]['currency'], 'USD');
$this->assertEquals($softContribution['values'][$softContribution['id']]['soft_credit_type_id'], 4);

//create a second soft contribution on the same hard contribution - we are testing that 'id' gets the right soft contribution id (not the contribution id)
$p['contact_id'] = $this->_softIndividual2Id;
$this->_softcontribution2 = $this->callAPISuccess('contribution_soft', 'create', $p);
$softContribution2 = $this->callAPISuccess('contribution_soft', 'create', $p);

// now we have 2 - test getcount
$softcontribution = $this->callAPISuccess('contribution_soft', 'getcount', []);
$this->assertEquals(2, $softcontribution);
$softContributionCount = $this->callAPISuccess('contribution_soft', 'getcount', []);
$this->assertEquals(2, $softContributionCount);

//check first contribution
$result = $this->callAPISuccess('contribution_soft', 'get', [
'id' => $this->_softcontribution['id'],
'id' => $softContribution['id'],
]);
$this->assertEquals(1, $result['count']);
$this->assertEquals($this->_softcontribution['id'], $result['id']);
$this->assertEquals($this->_softcontribution['id'], $result['id'], print_r($softcontribution, TRUE));
$this->assertEquals($softContribution['id'], $result['id']);

//test id only format - second soft credit
$resultID2 = $this->callAPISuccess('contribution_soft', 'get', [
'id' => $this->_softcontribution2['id'],
'id' => $softContribution2['id'],
'format.only_id' => 1,
]);
$this->assertEquals($this->_softcontribution2['id'], $resultID2);
$this->assertEquals($softContribution2['id'], $resultID2);

//test get by contact id works
$result = $this->callAPISuccess('contribution_soft', 'get', [
Expand All @@ -136,31 +124,31 @@ public function testGetContributionSoft() {
$this->assertEquals(1, $result['count']);

$this->callAPISuccess('contribution_soft', 'Delete', [
'id' => $this->_softcontribution['id'],
'id' => $softContribution['id'],
]);
// check one soft credit remains
$expectedCount = 1;
$this->callAPISuccess('contribution_soft', 'getcount', [], $expectedCount);

//check id is same as 2
$this->assertEquals($this->_softcontribution2['id'], $this->callAPISuccess('contribution_soft', 'getvalue', ['return' => 'id']));
$this->assertEquals($softContribution2['id'], $this->callAPISuccess('contribution_soft', 'getvalue', ['return' => 'id']));

$this->callAPISuccess('ContributionSoft', 'Delete', [
'id' => $this->_softcontribution2['id'],
'id' => $softContribution2['id'],
]);
}

/**
* civicrm_contribution_soft.
*/
public function testCreateEmptyParamsContributionSoft() {
$softcontribution = $this->callAPIFailure('contribution_soft', 'create', [],
$this->callAPIFailure('contribution_soft', 'create', [],
'Mandatory key(s) missing from params array: contribution_id, amount, contact_id'
);
}

public function testCreateParamsWithoutRequiredKeysContributionSoft() {
$softcontribution = $this->callAPIFailure('contribution_soft', 'create', [],
$this->callAPIFailure('contribution_soft', 'create', [],
'Mandatory key(s) missing from params array: contribution_id, amount, contact_id'
);
}
Expand All @@ -173,7 +161,7 @@ public function testCreateContributionSoftInvalidContact() {
'currency' => 'USD',
];

$softcontribution = $this->callAPIFailure('contribution_soft', 'create', $params,
$this->callAPIFailure('contribution_soft', 'create', $params,
'contact_id is not valid : 999'
);
}
Expand All @@ -186,7 +174,7 @@ public function testCreateContributionSoftInvalidContributionId() {
'currency' => 'USD',
];

$softcontribution = $this->callAPIFailure('contribution_soft', 'create', $params,
$this->callAPIFailure('contribution_soft', 'create', $params,
'contribution_id is not valid : 999999'
);
}
Expand All @@ -203,12 +191,12 @@ public function testCreateContributionSoft() {
'soft_credit_type_id' => 5,
];

$softcontribution = $this->callAPIAndDocument('contribution_soft', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($softcontribution['values'][$softcontribution['id']]['contribution_id'], $this->_contributionId);
$this->assertEquals($softcontribution['values'][$softcontribution['id']]['contact_id'], $this->_softIndividual1Id);
$this->assertEquals($softcontribution['values'][$softcontribution['id']]['amount'], '10');
$this->assertEquals($softcontribution['values'][$softcontribution['id']]['currency'], 'USD');
$this->assertEquals($softcontribution['values'][$softcontribution['id']]['soft_credit_type_id'], 5);
$softContribution = $this->callAPIAndDocument('contribution_soft', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($softContribution['values'][$softContribution['id']]['contribution_id'], $this->_contributionId);
$this->assertEquals($softContribution['values'][$softContribution['id']]['contact_id'], $this->_softIndividual1Id);
$this->assertEquals($softContribution['values'][$softContribution['id']]['amount'], '10');
$this->assertEquals($softContribution['values'][$softContribution['id']]['currency'], 'USD');
$this->assertEquals($softContribution['values'][$softContribution['id']]['soft_credit_type_id'], 5);
}

/**
Expand All @@ -225,21 +213,21 @@ public function testCreateUpdateContributionSoft() {
'soft_credit_type_id' => 6,
];

$softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
$softcontributionID = $softcontribution['id'];
$softContribution = $this->callAPISuccess('contribution_soft', 'create', $params);
$softContributionID = $softContribution['id'];

$old_params = [
'contribution_soft_id' => $softcontributionID,
'contribution_soft_id' => $softContributionID,
];
$original = $this->callAPISuccess('contribution_soft', 'get', $old_params);
//Make sure it came back
$this->assertEquals($original['id'], $softcontributionID);
$this->assertEquals($original['id'], $softContributionID);
//set up list of old params, verify
$old_contribution_id = $original['values'][$softcontributionID]['contribution_id'];
$old_contact_id = $original['values'][$softcontributionID]['contact_id'];
$old_amount = $original['values'][$softcontributionID]['amount'];
$old_currency = $original['values'][$softcontributionID]['currency'];
$old_soft_credit_type_id = $original['values'][$softcontributionID]['soft_credit_type_id'];
$old_contribution_id = $original['values'][$softContributionID]['contribution_id'];
$old_contact_id = $original['values'][$softContributionID]['contact_id'];
$old_amount = $original['values'][$softContributionID]['amount'];
$old_currency = $original['values'][$softContributionID]['currency'];
$old_soft_credit_type_id = $original['values'][$softContributionID]['soft_credit_type_id'];

//check against original values
$this->assertEquals($old_contribution_id, $this->_contributionId);
Expand All @@ -248,29 +236,29 @@ public function testCreateUpdateContributionSoft() {
$this->assertEquals($old_currency, 'USD');
$this->assertEquals($old_soft_credit_type_id, 6);
$params = [
'id' => $softcontributionID,
'id' => $softContributionID,
'contribution_id' => $this->_contributionId,
'contact_id' => $this->_softIndividual1Id,
'amount' => 7.00,
'currency' => 'CAD',
'soft_credit_type_id' => 7,
];

$softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
$softContribution = $this->callAPISuccess('contribution_soft', 'create', $params);

$new_params = [
'id' => $softcontribution['id'],
'id' => $softContribution['id'],
];
$softcontribution = $this->callAPISuccess('contribution_soft', 'get', $new_params);
$softContribution = $this->callAPISuccess('contribution_soft', 'get', $new_params);
//check against original values
$this->assertEquals($softcontribution['values'][$softcontributionID]['contribution_id'], $this->_contributionId);
$this->assertEquals($softcontribution['values'][$softcontributionID]['contact_id'], $this->_softIndividual1Id);
$this->assertEquals($softcontribution['values'][$softcontributionID]['amount'], 7.00);
$this->assertEquals($softcontribution['values'][$softcontributionID]['currency'], 'CAD');
$this->assertEquals($softcontribution['values'][$softcontributionID]['soft_credit_type_id'], 7);
$this->assertEquals($softContribution['values'][$softContributionID]['contribution_id'], $this->_contributionId);
$this->assertEquals($softContribution['values'][$softContributionID]['contact_id'], $this->_softIndividual1Id);
$this->assertEquals($softContribution['values'][$softContributionID]['amount'], 7.00);
$this->assertEquals($softContribution['values'][$softContributionID]['currency'], 'CAD');
$this->assertEquals($softContribution['values'][$softContributionID]['soft_credit_type_id'], 7);

$params = [
'id' => $softcontributionID,
'id' => $softContributionID,
];
$this->callAPISuccess('contribution_soft', 'delete', $params);
}
Expand All @@ -281,7 +269,7 @@ public function testCreateUpdateContributionSoft() {
*/
public function testDeleteEmptyParamsContributionSoft() {
$params = [];
$softcontribution = $this->callAPIFailure('contribution_soft', 'delete', $params);
$this->callAPIFailure('contribution_soft', 'delete', $params);
}

public function testDeleteWrongParamContributionSoft() {
Expand All @@ -300,10 +288,10 @@ public function testDeleteContributionSoft() {
'currency' => 'USD',
];

$softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
$softcontributionID = $softcontribution['id'];
$softContribution = $this->callAPISuccess('contribution_soft', 'create', $params);
$softContributionID = $softContribution['id'];
$params = [
'id' => $softcontributionID,
'id' => $softContributionID,
];
$this->callAPIAndDocument('contribution_soft', 'delete', $params, __FUNCTION__, __FILE__);
}
Expand All @@ -321,11 +309,11 @@ public function testSearchEmptyParams() {
'amount' => 10.00,
'currency' => 'USD',
];
$softcontribution = $this->callAPISuccess('contribution_soft', 'create', $p);
$softContribution = $this->callAPISuccess('contribution_soft', 'create', $p);

$result = $this->callAPISuccess('contribution_soft', 'get', []);
// We're taking the first element.
$res = $result['values'][$softcontribution['id']];
$res = $result['values'][$softContribution['id']];

$this->assertEquals($p['contribution_id'], $res['contribution_id']);
$this->assertEquals($p['contact_id'], $res['contact_id']);
Expand All @@ -343,21 +331,21 @@ public function testSearch() {
'amount' => 10.00,
'currency' => 'USD',
];
$softcontribution1 = $this->callAPISuccess('contribution_soft', 'create', $p1);
$softContribution1 = $this->callAPISuccess('contribution_soft', 'create', $p1);

$p2 = [
'contribution_id' => $this->_contributionId,
'contact_id' => $this->_softIndividual2Id,
'amount' => 25.00,
'currency' => 'CAD',
];
$softcontribution2 = $this->callAPISuccess('contribution_soft', 'create', $p2);
$softContribution2 = $this->callAPISuccess('contribution_soft', 'create', $p2);

$params = [
'id' => $softcontribution2['id'],
'id' => $softContribution2['id'],
];
$result = $this->callAPISuccess('contribution_soft', 'get', $params);
$res = $result['values'][$softcontribution2['id']];
$res = $result['values'][$softContribution2['id']];

$this->assertEquals($p2['contribution_id'], $res['contribution_id']);
$this->assertEquals($p2['contact_id'], $res['contact_id']);
Expand Down