Files
famous-ly4-ev/app-modules/payment/tests/Feature/RefundResourceTest.php
T
Nyan Lin Paing 231f5679ef Add refund action to booking list/detail with full-refund toggle
- New RefundBookingTableAction on the booking list row and detail page,
  refunding a Confirmed booking directly via RefundBookingAction — no need
  to hunt up its Payment on the Refunds resource first.
- Payment::refundableBalance() extracted from RefundBookingAction's private
  balance check so both refund forms can display and cap against it.
- RefundBookingAction::resolveRefundablePayment() made public for the same
  reason (round-trip leg resolution reused by the UI).
- Both refund forms (ProcessRefundAction and the new booking action) gain a
  "Full refund" toggle, on by default, which refunds the payment's whole
  remaining balance without requiring a manually typed amount. Turning it
  off reveals an amount field capped at the refundable balance.
2026-08-30 14:46:26 +07:00

229 lines
8.5 KiB
PHP

<?php
use App\Models\User;
use Livewire\Livewire;
use Modules\Booking\Enums\BookingStatus;
use Modules\Booking\Models\Booking;
use Modules\Payment\Contracts\PaymentGatewayInterface;
use Modules\Payment\Data\PaymentRequestData;
use Modules\Payment\Data\PaymentResultData;
use Modules\Payment\Data\RefundResultData;
use Modules\Payment\Enums\PaymentMethod;
use Modules\Payment\Enums\RefundStatus;
use Modules\Payment\Factories\PaymentGatewayFactory;
use Modules\Payment\Filament\Resources\Refunds\Pages\ListRefunds;
use Modules\Payment\Models\Payment;
use Modules\Payment\Models\Refund;
use Spatie\Permission\Models\Permission;
/**
* Never calls the real KBZ refund API in tests.
*/
class FakeFilamentRefundGateway implements PaymentGatewayInterface
{
public function initiate(PaymentRequestData $data): PaymentResultData
{
throw new RuntimeException('not needed for this test');
}
public function verify(string $gatewayTransactionId): PaymentResultData
{
throw new RuntimeException('not needed for this test');
}
public function refund(string $gatewayTransactionId, string $amount, string $reason): RefundResultData
{
return new RefundResultData(status: RefundStatus::Completed, gatewayRefundId: 'REFUND123', gatewayPayload: []);
}
public function handleWebhook(array $payload): PaymentResultData
{
throw new RuntimeException('not needed for this test');
}
}
beforeEach(function () {
foreach (['view_payments', 'process_refunds'] as $permission) {
Permission::findOrCreate($permission, 'web');
}
app(PaymentGatewayFactory::class)->register(PaymentMethod::KbzMiniApp, FakeFilamentRefundGateway::class);
});
test('a user with view_payments can list refunds', function () {
$viewer = User::factory()->create()->givePermissionTo('view_payments');
$this->actingAs($viewer);
$refunds = Refund::factory()->count(3)->create();
Livewire::test(ListRefunds::class)
->assertOk()
->assertCanSeeTableRecords($refunds);
});
test('the process action is hidden from a user without process_refunds', function () {
$viewer = User::factory()->create()->givePermissionTo('view_payments');
$this->actingAs($viewer);
Livewire::test(ListRefunds::class)
->assertActionHidden('process');
});
test('the process action is visible to a user with process_refunds', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
Livewire::test(ListRefunds::class)
->assertActionVisible('process');
});
test('processing a partial refund via the action calls RefundBookingAction and cancels the booking', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
$booking = Booking::factory()->create(['status' => BookingStatus::Confirmed, 'price' => 15000]);
$payment = Payment::factory()->completed()->create([
'booking_id' => $booking->id,
'gateway' => PaymentMethod::KbzMiniApp,
'amount' => 15000,
'gateway_transaction_id' => 'EVB-FILAMENT-REFUND-1',
]);
Livewire::test(ListRefunds::class)
->callAction('process', data: [
'payment_id' => $payment->id,
'full_refund' => false,
'amount' => 5000,
'reason' => 'customer requested cancellation',
])
->assertNotified();
expect($booking->refresh()->status)->toBe(BookingStatus::Cancelled)
->and(Refund::where('payment_id', $payment->id)->where('status', RefundStatus::Completed)->where('amount', 5000)->exists())->toBeTrue();
});
test('the full refund toggle refunds the payment\'s whole refundable balance without an amount input', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
$booking = Booking::factory()->create(['status' => BookingStatus::Confirmed, 'price' => 15000]);
$payment = Payment::factory()->completed()->create([
'booking_id' => $booking->id,
'gateway' => PaymentMethod::KbzMiniApp,
'amount' => 15000,
'gateway_transaction_id' => 'EVB-FILAMENT-FULL-1',
]);
Livewire::test(ListRefunds::class)
->callAction('process', data: [
'payment_id' => $payment->id,
'full_refund' => true,
'reason' => 'customer requested cancellation',
])
->assertNotified();
expect(Refund::where('payment_id', $payment->id)->where('status', RefundStatus::Completed)->where('amount', 15000)->exists())->toBeTrue();
});
test('the full refund toggle defaults to on', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
Livewire::test(ListRefunds::class)
->mountAction('process')
->assertActionDataSet(['full_refund' => true]);
});
test('turning the full refund toggle off requires an amount', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
$payment = Payment::factory()->completed()->create([
'gateway' => PaymentMethod::KbzMiniApp,
'amount' => 15000,
]);
Livewire::test(ListRefunds::class)
->callAction('process', data: [
'payment_id' => $payment->id,
'full_refund' => false,
'reason' => 'reason',
])
->assertHasFormErrors(['amount' => 'required']);
});
test('a non-completed payment is not offered in the process action\'s payment select', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
$booking = Booking::factory()->create(['status' => BookingStatus::PendingPayment]);
$pendingPayment = Payment::factory()->create([
'booking_id' => $booking->id,
'gateway' => PaymentMethod::KbzMiniApp,
]);
// The Select itself rejects a value outside its "Completed only"
// options (domain.md §6) — RefundBookingAction's own guard against a
// non-confirmed booking is covered directly in RefundBookingActionTest.
Livewire::test(ListRefunds::class)
->callAction('process', data: [
'payment_id' => $pendingPayment->id,
'amount' => 1000,
'reason' => 'reason',
])
->assertHasFormErrors(['payment_id']);
expect(Refund::where('payment_id', $pendingPayment->id)->exists())->toBeFalse();
});
test('a payment whose booking has been soft-deleted is not offered in the process action\'s payment select', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
$booking = Booking::factory()->create(['status' => BookingStatus::Cancelled, 'price' => 15000]);
$payment = Payment::factory()->completed()->create([
'booking_id' => $booking->id,
'gateway' => PaymentMethod::KbzMiniApp,
'amount' => 15000,
'gateway_transaction_id' => 'EVB-FILAMENT-DELETED-1',
]);
$booking->delete();
// Regression: a payment whose booking is gone must never crash the
// refund action (RefundBookingAction requires a non-null Booking) — it
// simply isn't offered as an option at all.
Livewire::test(ListRefunds::class)
->callAction('process', data: [
'payment_id' => $payment->id,
'amount' => 1000,
'reason' => 'reason',
])
->assertHasFormErrors(['payment_id']);
expect(Refund::where('payment_id', $payment->id)->exists())->toBeFalse();
});
test('the process action\'s amount field is capped at the selected payment\'s refundable balance', function () {
$admin = User::factory()->create()->givePermissionTo(['view_payments', 'process_refunds']);
$this->actingAs($admin);
$booking = Booking::factory()->create(['status' => BookingStatus::Confirmed, 'price' => 15000]);
$payment = Payment::factory()->completed()->create([
'booking_id' => $booking->id,
'gateway' => PaymentMethod::KbzMiniApp,
'amount' => 15000,
'gateway_transaction_id' => 'EVB-FILAMENT-MAX-1',
]);
Livewire::test(ListRefunds::class)
->callAction('process', data: [
'payment_id' => $payment->id,
'full_refund' => false,
'amount' => 15000.01,
'reason' => 'reason',
])
->assertHasFormErrors(['amount' => 'max']);
expect(Refund::where('payment_id', $payment->id)->exists())->toBeFalse();
});