Skip to content
Snippets Groups Projects
Commit 16d90974 authored by mattwire's avatar mattwire
Browse files

Fix recording balancetransaction details (eg. available_on) on FinancialTrxn... 

Fix recording balancetransaction details (eg. available_on) on FinancialTrxn when payment is completed immediately (eg. Contribution page) and add tests to cover this scenario
parent 86391479
Branches
Tags
1 merge request!223Fix recording balancetransaction details (eg. available_on) on FinancialTrxn...
Hide whitespace changes
Inline Side-by-side
Civi/Stripe/Webhook/Events.php
+ 35
− 0
View file @ 16d90974
......@@ -311,6 +311,7 @@ class Events {
$pendingContributionStatusID = (int) \CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
$failedContributionStatusID = (int) \CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Failed');
$completedContributionStatusID = (int) \CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
$statusesAllowedToComplete = [$pendingContributionStatusID, $failedContributionStatusID];
// If contribution is in Pending or Failed state record payment and transition to Completed
......@@ -330,6 +331,40 @@ class Events {
$this->updateContributionCompleted($contributionParams);
}
elseif ($contribution['contribution_status_id'] === $completedContributionStatusID) {
// By this point we should have a contribution and a completed payment
$financialTrxn = \Civi\Api4\FinancialTrxn::get(FALSE)
->addSelect('*', 'custom.*')
->addWhere('trxn_id', '=', $chargeID)
->addWhere('is_payment', '=', TRUE)
->addWhere('status_id:name', '=', 'Completed')
->execute()
->first();
$return->message = __FUNCTION__ . ' contributionID: ' . $contribution['id'] . ' already completed. No additional payment details added';
if (empty($financialTrxn['Payment_details.available_on'])) {
$balanceTransactionDetails = $this->api->getDetailsFromBalanceTransaction($chargeID, $this->getData()->object);
foreach ($balanceTransactionDetails as $key => $value) {
$paymentParams[$key] = $value;
}
$customFields = \Civi\Api4\CustomField::get(FALSE)
->addWhere('custom_group_id:name', '=', 'Payment_details')
->execute()
->indexBy('name');
foreach ($customFields as $key => $value) {
if (isset($paymentParams[$key])) {
$customParams['custom_' . $value['id']] = $paymentParams[$key];
}
}
if (!empty($customParams)) {
$customParams['entity_id'] = $financialTrxn['id'];
civicrm_api3('CustomValue', 'create', $customParams);
$return->message = __FUNCTION__ . ' contributionID: ' . $contribution['id'] . ' already completed. Added additional payment details';
}
}
$return->ok = TRUE;
return $return;
}
$return->message = __FUNCTION__ . ' contributionID: ' . $contribution['id'];
$return->ok = TRUE;
......
tests/phpunit/CRM/Stripe/BaseTest.php
+ 167
− 0
View file @ 16d90974
......@@ -198,6 +198,173 @@ abstract class CRM_Stripe_BaseTest extends \PHPUnit\Framework\TestCase implement
return $dt->format('Y-m-d H:i:s');
}
protected function getMocksForOneOffPayment() {
PropertySpy::$buffer = 'none';
// Set this to 'print' or 'log' maybe more helpful in debugging but for
// generally running tests 'exception' suits as we don't expect any output.
PropertySpy::$outputMode = 'exception';
// Create a mock stripe client.
$stripeClient = $this->createMock('Stripe\\StripeClient');
// Update our CRM_Core_Payment_Stripe object and ensure any others
// instantiated separately will also use it.
$this->paymentObject->setMockStripeClient($stripeClient);
// Mock the payment methods service.
$mockPaymentMethod = $this->createMock('Stripe\\PaymentMethod');
$mockPaymentMethod->method('__get')
->will($this->returnValueMap([
[ 'id', 'pm_mock']
]));
$stripeClient->paymentMethods = $this->createMock('Stripe\\Service\\PaymentMethodService');
$stripeClient->paymentMethods
->method('create')
->willReturn($mockPaymentMethod);
$stripeClient->paymentMethods
->method('retrieve')
->with($this->equalTo('pm_mock'))
->willReturn($mockPaymentMethod);
// Mock the Customers service
$stripeClient->customers = $this->createMock('Stripe\\Service\\CustomerService');
$stripeClient->customers
->method('create')
->willReturn(
new PropertySpy('customers.create', ['id' => 'cus_mock'])
);
$stripeClient->customers
->method('retrieve')
->with($this->equalTo('cus_mock'))
->willReturn(
new PropertySpy('customers.retrieve', ['id' => 'cus_mock'])
);
// Need a mock intent with id and status
$mockCharge = $this->createMock('Stripe\\Charge');
$mockCharge
->method('__get')
->will($this->returnValueMap([
['id', 'ch_mock'],
['captured', TRUE],
['status', 'succeeded'],
['balance_transaction', 'txn_mock'],
]));
$mockChargesCollection = new \Stripe\Collection();
$mockChargesCollection->data = [$mockCharge];
$mockCharge = new PropertySpy('Charge', [
'id' => 'ch_mock',
'object' => 'charge',
'captured' => TRUE,
'status' => 'succeeded',
'balance_transaction' => 'txn_mock',
'amount' => $this->total * 100,
]);
$stripeClient->charges = $this->createMock('Stripe\\Service\\ChargeService');
$stripeClient->charges
->method('retrieve')
->with($this->equalTo('ch_mock'))
->willReturn($mockCharge);
$mockPaymentIntent = new PropertySpy('PaymentIntent', [
'id' => 'pi_mock',
'status' => 'succeeded',
'latest_charge' => 'ch_mock'
]);
$stripeClient->paymentIntents = $this->createMock('Stripe\\Service\\PaymentIntentService');
$stripeClient->paymentIntents
->method('retrieve')
->with($this->equalTo('pi_mock'))
->willReturn($mockPaymentIntent);
$mockPaymentIntentWithAmount = new PropertySpy('PaymentIntent', [
'id' => 'pi_mock',
'status' => 'succeeded',
'latest_charge' => 'ch_mock',
'amount' => '40000',
]);
$stripeClient->paymentIntents
->method('update')
->with($this->equalTo('pi_mock'))
->willReturn($mockPaymentIntentWithAmount);
$stripeClient->balanceTransactions = $this->createMock('Stripe\\Service\\BalanceTransactionService');
$stripeClient->balanceTransactions
->method('retrieve')
->with($this->equalTo('txn_mock'))
->willReturn(new PropertySpy('balanceTransaction', [
'id' => 'txn_mock',
'fee' => 1190, /* means $11.90 */
'currency' => 'usd',
'exchange_rate' => NULL,
'object' => 'balance_transaction',
'available_on' => '1686427505' // 2023-06-10 21:05:05
]));
$mockRefund = new PropertySpy('Refund', [
'amount_refunded' => $this->total*100,
'charge_id' => 'ch_mock', //xxx
'created' => time(),
'currency' => 'usd',
'id' => 're_mock',
'object' => 'refund',
]);
$stripeClient->refunds = $this->createMock('Stripe\\Service\\RefundService');
$stripeClient->refunds
->method('all')
->willReturn(new PropertySpy('refunds.all', [ 'data' => [ $mockRefund ] ]));
}
/**
* DRY code. Sets up the database as it would be after a recurring contrib
* has been set up with Stripe.
*
* Results in a pending ContributionRecur and a pending Contribution record.
*
* The following mock Stripe IDs strings are used:
*
* - pm_mock PaymentMethod
* - pi_mock PaymentIntent
* - cus_mock Customer
* - ch_mock Charge
* - txn_mock Balance transaction
* - sub_mock Subscription
*
* @return array The result from doPayment()
* @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
* @throws \Civi\Payment\Exception\PaymentProcessorException
* @throws \Stripe\Exception\ApiErrorException
*/
protected function mockOneOffPaymentSetup(): array {
$this->getMocksForOneOffPayment();
$this->setupPendingContribution();
// Submit the payment.
$payment_extra_params = [
'contributionID' => $this->contributionID,
'paymentIntentID' => 'pi_mock',
];
// Simulate payment
$this->assertInstanceOf('CRM_Core_Payment_Stripe', $this->paymentObject);
$doPaymentResult = $this->doPaymentStripe($payment_extra_params);
//
// Check the Contribution
// ...should be pending
// ...its transaction ID should be our Charge ID.
//
$this->checkContrib([
'contribution_status_id' => 'Pending',
'trxn_id' => 'ch_mock',
]);
return $doPaymentResult;
}
/**
* Submit to stripe
*
......
tests/phpunit/CRM/Stripe/DirectTest.php
+ 21
− 190
View file @ 16d90974
......@@ -26,200 +26,31 @@ class CRM_Stripe_DirectTest extends CRM_Stripe_BaseTest {
}
/**
* DRY code. Sets up the Stripe objects needed to import a subscription
*
* The following mock Stripe IDs strings are used:
*
* - pm_mock PaymentMethod
* - pi_mock PaymentIntent
* - cus_mock Customer
* - ch_mock Charge
* - txn_mock Balance transaction
* - sub_mock Subscription
*
* @return \PHPUnit\Framework\MockObject\MockObject
* Test making a one-off contribution.
*/
protected function mockStripe($subscriptionParams = []) {
$subscriptionParams['hasPaidInvoice'] = $subscriptionParams['hasPaidInvoice'] ?? TRUE;
PropertySpy::$buffer = 'none';
// Set this to 'print' or 'log' maybe more helpful in debugging but for
// generally running tests 'exception' suits as we don't expect any output.
PropertySpy::$outputMode = 'exception';
$this->assertInstanceOf('CRM_Core_Payment_Stripe', $this->paymentObject);
// Create a mock stripe client.
$stripeClient = $this->createMock('Stripe\\StripeClient');
// Update our CRM_Core_Payment_Stripe object and ensure any others
// instantiated separately will also use it.
$this->paymentObject->setMockStripeClient($stripeClient);
// Mock the Customers service
$stripeClient->customers = $this->createMock('Stripe\\Service\\CustomerService');
$stripeClient->customers
->method('create')
->willReturn(
new PropertySpy('customers.create', ['id' => 'cus_mock'])
);
$stripeClient->customers
->method('retrieve')
->with($this->equalTo('cus_mock'))
->willReturn(
new PropertySpy('customers.retrieve', ['id' => 'cus_mock'])
);
$mockPlan = $this->createMock('Stripe\\Plan');
$mockPlan
->method('__get')
->will($this->returnValueMap([
['id', 'every-1-month-' . ($this->total * 100) . '-usd-test'],
['amount', $this->total*100],
['currency', 'usd'],
['interval_count', $this->contributionRecur['frequency_interval']],
['interval', $this->contributionRecur['frequency_unit']],
]));
$stripeClient->plans = $this->createMock('Stripe\\Service\\PlanService');
$stripeClient->plans
->method('retrieve')
->willReturn($mockPlan);
$mockSubscriptionParams = [
'id' => 'sub_mock',
'object' => 'subscription',
'customer' => 'cus_mock',
'current_period_end' => time()+60*60*24,
'pending_setup_intent' => '',
'plan' => $mockPlan,
'start_date' => time(),
];
if ($subscriptionParams['hasPaidInvoice']) {
// Need a mock intent with id and status
$mockCharge = $this->createMock('Stripe\\Charge');
$mockCharge
->method('__get')
->will($this->returnValueMap([
['id', 'ch_mock'],
['object', 'charge'],
['captured', TRUE],
['status', 'succeeded'],
['balance_transaction', 'txn_mock'],
['invoice', 'in_mock']
]));
$mockChargesCollection = new \Stripe\Collection();
$mockChargesCollection->data = [$mockCharge];
$mockPaymentIntent = $this->createMock('Stripe\\PaymentIntent');
$mockPaymentIntent
->method('__get')
->will($this->returnValueMap([
['id', 'pi_mock'],
['status', 'succeeded'],
['charges', $mockChargesCollection]
]));
$mockSubscriptionParams['latest_invoice'] = [
'id' => 'in_mock',
'payment_intent' => $mockPaymentIntent,
];
}
$stripeClient->paymentIntents = $this->createMock('Stripe\\Service\\PaymentIntentService');
$stripeClient->paymentIntents
->method('create')
->willReturn($mockPaymentIntent);
$stripeClient->paymentIntents
->method('retrieve')
->willReturn($mockPaymentIntent);
$mockPaymentMethodParams = [
'id' => 'pm_mock',
];
$mockPaymentMethod = new PropertySpy('paymentMethod', $mockPaymentMethodParams);
$stripeClient->paymentMethods = $this->createMock('Stripe\\Service\\PaymentMethodService');
$stripeClient->paymentMethods
->method('create')
->willReturn($mockPaymentMethod);
$mockSubscription = new PropertySpy('subscription.create', $mockSubscriptionParams);
$stripeClient->subscriptions = $this->createMock('Stripe\\Service\\SubscriptionService');
$stripeClient->subscriptions
->method('create')
->willReturn($mockSubscription);
$stripeClient->subscriptions
->method('retrieve')
->with($this->equalTo('sub_mock'))
->willReturn($mockSubscription);
if ($subscriptionParams['hasPaidInvoice']) {
$stripeClient->balanceTransactions = $this->createMock('Stripe\\Service\\BalanceTransactionService');
$stripeClient->balanceTransactions
->method('retrieve')
->with($this->equalTo('txn_mock'))
->willReturn(new PropertySpy('balanceTransaction', [
'id' => 'txn_mock',
'fee' => 1190, /* means $11.90 */
'currency' => 'usd',
'exchange_rate' => NULL,
'object' => 'balance_transaction',
]));
$mockCharge = new PropertySpy('Charge', [
'id' => 'ch_mock',
'object' => 'charge',
'captured' => TRUE,
'status' => 'succeeded',
'balance_transaction' => 'txn_mock',
'invoice' => 'in_mock'
]);
$stripeClient->charges = $this->createMock('Stripe\\Service\\ChargeService');
$stripeClient->charges
->method('retrieve')
->with($this->equalTo('ch_mock'))
->willReturn($mockCharge);
$mockInvoice = new PropertySpy('Invoice', [
'amount_due' => $this->total * 100,
'charge' => 'ch_mock', //xxx
'created' => time(),
'currency' => 'usd',
'customer' => 'cus_mock',
'id' => 'in_mock',
'object' => 'invoice',
'subscription' => 'sub_mock',
'paid' => TRUE
public function testDirectSuccess() {
$doPaymentResult = $this->mockOneOffPaymentSetup();
if ($doPaymentResult['payment_status'] === 'Completed') {
civicrm_api3('Payment', 'create', [
'trxn_id' => $doPaymentResult['trxn_id'],
'total_amount' => $this->total,
'fee_amount' => $doPaymentResult['fee_amount'],
'order_reference' => $doPaymentResult['order_reference'],
'contribution_id' => $this->contributionID,
]);
$mockInvoicesCollection = new \Stripe\Collection();
$mockInvoicesCollection->data = [$mockInvoice];
$stripeClient->invoices = $this->createMock('Stripe\\Service\\InvoiceService');
$stripeClient->invoices
->method('all')
->willReturn($mockInvoicesCollection);
$stripeClient->invoices
->method('retrieve')
->with($this->equalTo('in_mock'))
->willReturn($mockInvoice);
}
else {
// No invoices
$mockInvoicesCollection = new \Stripe\Collection();
$mockInvoicesCollection->data = [];
$stripeClient->invoices = $this->createMock('Stripe\\Service\\InvoiceService');
$stripeClient->invoices
->method('all')
->willReturn($mockInvoicesCollection);
}
}
/**
* Test making a recurring contribution.
* @fixme This test currently doesn't work (needs work on mockStripe() to return the right responses for paymentIntents)
*
public function testDirectSuccess() {
$this->setupTransaction();
$this->mockStripe();
$this->doPayment();
$this->assertValidTrxn();
}*/
//
// Check the Contribution
// ...should be Completed
// ...its transaction ID should be our Charge ID.
//
$this->checkContrib([
'contribution_status_id' => 'Completed',
'trxn_id' => 'ch_mock',
]);
}
public function testDummy() {
return;
......
tests/phpunit/CRM/Stripe/IpnTest.php
+ 78
− 167
View file @ 16d90974
......@@ -73,6 +73,84 @@ class CRM_Stripe_IpnTest extends CRM_Stripe_BaseTest {
]);
}
/**
* Test "direct" creation (ie. contribution page) where contribution is Completed immediately.
*/
public function testNewOneOffChargeSucceededAlreadyCompleted() {
// Run "payment".
$doPaymentResult = $this->mockOneOffPaymentSetup();
// Now add a "Completed" payment per contribution page flow
if ($doPaymentResult['payment_status'] === 'Completed') {
civicrm_api3('Payment', 'create', [
'trxn_id' => $doPaymentResult['trxn_id'],
'total_amount' => $this->total,
'fee_amount' => $doPaymentResult['fee_amount'],
'order_reference' => $doPaymentResult['order_reference'],
'contribution_id' => $this->contributionID,
]);
}
// Contribution should be marked as Completed
$this->checkContrib([
'contribution_status_id' => 'Completed',
'trxn_id' => 'ch_mock',
'total_amount' => $this->total,
]);
// Financial trxn should have empty "available_on" at this point
$this->checkFinancialTrxn([
'Payment_details.available_on' => '',
'fee_amount' => 11.90,
'total_amount' => $this->total,
'order_reference' => 'ch_mock',
'trxn_id' => 'ch_mock'
],
$this->contributionID
);
$success = $this->simulateEvent([
'type' => 'charge.succeeded',
'id' => 'evt_mock',
'object' => 'event', // ?
'livemode' => FALSE,
'pending_webhooks' => 0,
'request' => [ 'id' => NULL ],
'data' => [
'object' => [
'id' => 'ch_mock',
'object' => 'charge',
'customer' => 'cus_mock',
'charge' => 'ch_mock',
'balance_transaction' => 'txn_mock',
'created' => time(),
'amount' => $this->total*100,
'currency' => 'usd',
'status' => 'succeeded',
"captured" => TRUE,
]
],
]);
$this->assertEquals(TRUE, $success, 'IPN did not return OK');
// No change here.
$this->checkContrib([
'contribution_status_id' => 'Completed',
'trxn_id' => 'ch_mock',
'total_amount' => $this->total,
]);
// Now we should have a value for available_on
$this->checkFinancialTrxn([
'Payment_details.available_on' => $this->getDateinCurrentTimezone('2023-06-10 20:05:05'),
'fee_amount' => 11.90,
'total_amount' => $this->total,
'order_reference' => 'ch_mock',
'trxn_id' => 'ch_mock'
],
$this->contributionID
);
}
/**
* Test completing a one-off contribution with trxn_id = paymentIntentID
* For Stripe checkout we find the contribution using contribution.invoice_id=checkout.client_reference_id
......@@ -1257,173 +1335,6 @@ class CRM_Stripe_IpnTest extends CRM_Stripe_BaseTest {
return [$mockCharge1, $mockCharge2, $mockInvoice2, $balanceTransaction2];
}
protected function getMocksForOneOffPayment() {
PropertySpy::$buffer = 'none';
// Set this to 'print' or 'log' maybe more helpful in debugging but for
// generally running tests 'exception' suits as we don't expect any output.
PropertySpy::$outputMode = 'exception';
// Create a mock stripe client.
$stripeClient = $this->createMock('Stripe\\StripeClient');
// Update our CRM_Core_Payment_Stripe object and ensure any others
// instantiated separately will also use it.
$this->paymentObject->setMockStripeClient($stripeClient);
// Mock the payment methods service.
$mockPaymentMethod = $this->createMock('Stripe\\PaymentMethod');
$mockPaymentMethod->method('__get')
->will($this->returnValueMap([
[ 'id', 'pm_mock']
]));
$stripeClient->paymentMethods = $this->createMock('Stripe\\Service\\PaymentMethodService');
$stripeClient->paymentMethods
->method('create')
->willReturn($mockPaymentMethod);
$stripeClient->paymentMethods
->method('retrieve')
->with($this->equalTo('pm_mock'))
->willReturn($mockPaymentMethod);
// Mock the Customers service
$stripeClient->customers = $this->createMock('Stripe\\Service\\CustomerService');
$stripeClient->customers
->method('create')
->willReturn(
new PropertySpy('customers.create', ['id' => 'cus_mock'])
);
$stripeClient->customers
->method('retrieve')
->with($this->equalTo('cus_mock'))
->willReturn(
new PropertySpy('customers.retrieve', ['id' => 'cus_mock'])
);
// Need a mock intent with id and status
$mockCharge = $this->createMock('Stripe\\Charge');
$mockCharge
->method('__get')
->will($this->returnValueMap([
['id', 'ch_mock'],
['captured', TRUE],
['status', 'succeeded'],
['balance_transaction', 'txn_mock'],
]));
$mockChargesCollection = new \Stripe\Collection();
$mockChargesCollection->data = [$mockCharge];
$mockCharge = new PropertySpy('Charge', [
'id' => 'ch_mock',
'object' => 'charge',
'captured' => TRUE,
'status' => 'succeeded',
'balance_transaction' => 'txn_mock',
'amount' => $this->total * 100,
]);
$stripeClient->charges = $this->createMock('Stripe\\Service\\ChargeService');
$stripeClient->charges
->method('retrieve')
->with($this->equalTo('ch_mock'))
->willReturn($mockCharge);
$mockPaymentIntent = new PropertySpy('PaymentIntent', [
'id' => 'pi_mock',
'status' => 'succeeded',
'latest_charge' => 'ch_mock'
]);
$stripeClient->paymentIntents = $this->createMock('Stripe\\Service\\PaymentIntentService');
$stripeClient->paymentIntents
->method('retrieve')
->with($this->equalTo('pi_mock'))
->willReturn($mockPaymentIntent);
$mockPaymentIntentWithAmount = new PropertySpy('PaymentIntent', [
'id' => 'pi_mock',
'status' => 'succeeded',
'latest_charge' => 'ch_mock',
'amount' => '40000',
]);
$stripeClient->paymentIntents
->method('update')
->with($this->equalTo('pi_mock'))
->willReturn($mockPaymentIntentWithAmount);
$stripeClient->balanceTransactions = $this->createMock('Stripe\\Service\\BalanceTransactionService');
$stripeClient->balanceTransactions
->method('retrieve')
->with($this->equalTo('txn_mock'))
->willReturn(new PropertySpy('balanceTransaction', [
'id' => 'txn_mock',
'fee' => 1190, /* means $11.90 */
'currency' => 'usd',
'exchange_rate' => NULL,
'object' => 'balance_transaction',
'available_on' => '1686427505' // 2023-06-10 21:05:05
]));
$mockRefund = new PropertySpy('Refund', [
'amount_refunded' => $this->total*100,
'charge_id' => 'ch_mock', //xxx
'created' => time(),
'currency' => 'usd',
'id' => 're_mock',
'object' => 'refund',
]);
$stripeClient->refunds = $this->createMock('Stripe\\Service\\RefundService');
$stripeClient->refunds
->method('all')
->willReturn(new PropertySpy('refunds.all', [ 'data' => [ $mockRefund ] ]));
}
/**
* DRY code. Sets up the database as it would be after a recurring contrib
* has been set up with Stripe.
*
* Results in a pending ContributionRecur and a pending Contribution record.
*
* The following mock Stripe IDs strings are used:
*
* - pm_mock PaymentMethod
* - pi_mock PaymentIntent
* - cus_mock Customer
* - ch_mock Charge
* - txn_mock Balance transaction
* - sub_mock Subscription
*
* @return array The result from doPayment()
* @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
* @throws \Civi\Payment\Exception\PaymentProcessorException
* @throws \Stripe\Exception\ApiErrorException
*/
protected function mockOneOffPaymentSetup(): array {
$this->getMocksForOneOffPayment();
$this->setupPendingContribution();
// Submit the payment.
$payment_extra_params = [
'contributionID' => $this->contributionID,
'paymentIntentID' => 'pi_mock',
];
// Simulate payment
$this->assertInstanceOf('CRM_Core_Payment_Stripe', $this->paymentObject);
$doPaymentResult = $this->doPaymentStripe($payment_extra_params);
//
// Check the Contribution
// ...should be pending
// ...its transaction ID should be our Charge ID.
//
$this->checkContrib([
'contribution_status_id' => 'Pending',
'trxn_id' => 'ch_mock',
]);
return $doPaymentResult;
}
/**
* @return void
*/
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment