Fix AllocateOverpaymentActionTest to avoid Payment API interference

Create overpaid contributions in setUpBeforeClass() before parent::setUp()
modifies financial accounts, which was causing 'Array to string conversion'
errors in Payment.create calls.

The test now pre-creates all needed overpaid contributions before the test
class setup runs, avoiding the conflict between financial account modifications
and the Payment API.

Author: erawat

tests/phpunit/Civi/Api4/Action/CreditNote/AllocateOverpaymentActionTest.php

@@ -8,6 +8,7 @@
 use Civi\Api4\FinancialTrxn;
 use Civi\Financeextras\Test\Helper\CreditNoteTrait;
 use Civi\Financeextras\Test\Fabricator\ContactFabricator;
+use Civi\Financeextras\Test\Fabricator\ContributionFabricator;
 
 /**
  * CreditNote.AllocateOverpayment API Test Case.
@@ -18,13 +19,90 @@ class Civi_Api4_CreditNote_AllocateOverpaymentActionTest extends BaseHeadlessTes
 
   use CreditNoteTrait;
 
+  /**
+   * Pre-created overpaid contributions for tests.
+   *
+   * Created in setUpBeforeClass() before parent::setUp() modifies
+   * financial accounts, which would cause Payment.create to fail.
+   *
+   * @var array
+   */
+  private static array $overpaidContributions = [];
+
+  /**
+   * Pre-created contacts for tests.
+   *
+   * @var array
+   */
+  private static array $contacts = [];
+
+  /**
+   * Counter for which contribution to use next.
+   *
+   * @var int
+   */
+  private static int $contributionIndex = 0;
+
   /**
    * The overpayment financial type ID.
    *
    * @var int
    */
   private $overpaymentFinancialTypeId;
 
+  /**
+   * {@inheritDoc}
+   */
+  public static function setUpBeforeClass(): void {
+    // Create contributions BEFORE parent::setUp() runs to avoid interference
+    // with the Payment API. The parent::setUp() modifies financial accounts
+    // which can cause "Array to string conversion" errors in Payment.create.
+
+    // Create 10 overpaid contributions (more than enough for all tests).
+    for ($i = 0; $i < 10; $i++) {
+      $contact = ContactFabricator::fabricate();
+      self::$contacts[$i] = $contact;
+
+      // Determine amounts - most use 100/150, one uses 100/175.
+      $invoiceAmount = 100;
+      $paidAmount = ($i === 9) ? 175 : 150;
+
+      $trxnId = md5(uniqid() . $i);
+      $contributionParams = [
+        'financial_type_id' => 'Donation',
+        'receive_date' => date('Y-m-d'),
+        'total_amount' => $invoiceAmount,
+        'contact_id' => $contact['id'],
+        'payment_instrument_id' => 'Credit Card',
+        'trxn_id' => $trxnId,
+        'currency' => 'GBP',
+        'contribution_status_id' => 2,
+      ];
+
+      $contribution = ContributionFabricator::fabricate($contributionParams);
+
+      // Create overpayment by paying more than invoice amount.
+      civicrm_api3('Payment', 'create', [
+        'contribution_id' => $contribution['id'],
+        'total_amount' => $paidAmount,
+        'trxn_date' => date('Y-m-d H:i:s'),
+        'trxn_id' => $trxnId,
+        'is_send_contribution_notification' => FALSE,
+      ]);
+
+      // Store with amounts for reference.
+      self::$overpaidContributions[$i] = [
+        'id' => $contribution['id'],
+        'contact_id' => $contact['id'],
+        'invoice_amount' => $invoiceAmount,
+        'paid_amount' => $paidAmount,
+        'overpayment_amount' => $paidAmount - $invoiceAmount,
+      ];
+    }
+
+    self::$contributionIndex = 0;
+  }
+
   /**
    * {@inheritDoc}
    */
@@ -50,20 +128,43 @@ public function setUp() {
       ->execute();
   }
 
+  /**
+   * Get the next available overpaid contribution.
+   *
+   * @return array
+   *   The contribution data with id, contact_id, invoice_amount,
+   *   paid_amount, overpayment_amount.
+   */
+  private function getNextOverpaidContribution(): array {
+    $contribution = self::$overpaidContributions[self::$contributionIndex];
+    self::$contributionIndex++;
+    return $contribution;
+  }
+
+  /**
+   * Get the contribution with larger overpayment (75 instead of 50).
+   *
+   * @return array
+   *   The contribution data.
+   */
+  private function getLargerOverpaymentContribution(): array {
+    // Index 9 has 100/175 = 75 overpayment.
+    return self::$overpaidContributions[9];
+  }
+
   /**
    * Test allocate overpayment creates credit note with correct data.
    */
   public function testAllocateOverpaymentCreatesCreditNote() {
-    $contact = ContactFabricator::fabricate();
-    $contribution = $this->createOverpaidContribution($contact['id'], 100.00, 150.00);
+    $contribution = $this->getNextOverpaidContribution();
 
     $result = CreditNote::allocateOverpayment(FALSE)
       ->setContributionId($contribution['id'])
       ->execute()
       ->first();
 
     $this->assertNotEmpty($result['id']);
-    $this->assertEquals($contact['id'], $result['contact_id']);
+    $this->assertEquals($contribution['contact_id'], $result['contact_id']);
     $this->assertEquals('GBP', $result['currency']);
 
     $creditNote = CreditNote::get(FALSE)
@@ -79,12 +180,8 @@ public function testAllocateOverpaymentCreatesCreditNote() {
    * Test allocate overpayment creates line item with correct data.
    */
   public function testAllocateOverpaymentCreatesCorrectLineItem() {
-    $contact = ContactFabricator::fabricate();
-    $invoiceAmount = 100.00;
-    $paidAmount = 150.00;
-    $overpaymentAmount = $paidAmount - $invoiceAmount;
-
-    $contribution = $this->createOverpaidContribution($contact['id'], $invoiceAmount, $paidAmount);
+    $contribution = $this->getNextOverpaidContribution();
+    $overpaymentAmount = $contribution['overpayment_amount'];
 
     $result = CreditNote::allocateOverpayment(FALSE)
       ->setContributionId($contribution['id'])
@@ -110,12 +207,8 @@ public function testAllocateOverpaymentCreatesCorrectLineItem() {
    * Test allocate overpayment records negative payment on contribution.
    */
   public function testAllocateOverpaymentRecordsNegativePayment() {
-    $contact = ContactFabricator::fabricate();
-    $invoiceAmount = 100.00;
-    $paidAmount = 150.00;
-    $overpaymentAmount = $paidAmount - $invoiceAmount;
-
-    $contribution = $this->createOverpaidContribution($contact['id'], $invoiceAmount, $paidAmount);
+    $contribution = $this->getNextOverpaidContribution();
+    $overpaymentAmount = $contribution['overpayment_amount'];
 
     $result = CreditNote::allocateOverpayment(FALSE)
       ->setContributionId($contribution['id'])
@@ -136,8 +229,7 @@ public function testAllocateOverpaymentRecordsNegativePayment() {
    * Test allocate overpayment changes contribution status to completed.
    */
   public function testAllocateOverpaymentChangesContributionStatusToCompleted() {
-    $contact = ContactFabricator::fabricate();
-    $contribution = $this->createOverpaidContribution($contact['id'], 100.00, 150.00);
+    $contribution = $this->getNextOverpaidContribution();
 
     $initialContribution = Contribution::get(FALSE)
       ->addWhere('id', '=', $contribution['id'])
@@ -163,8 +255,7 @@ public function testAllocateOverpaymentChangesContributionStatusToCompleted() {
    * Test allocate overpayment payment status is completed not refunded.
    */
   public function testAllocateOverpaymentPaymentStatusIsCompleted() {
-    $contact = ContactFabricator::fabricate();
-    $contribution = $this->createOverpaidContribution($contact['id'], 100.00, 150.00);
+    $contribution = $this->getNextOverpaidContribution();
 
     $result = CreditNote::allocateOverpayment(FALSE)
       ->setContributionId($contribution['id'])
@@ -186,8 +277,7 @@ public function testAllocateOverpaymentPaymentStatusIsCompleted() {
   public function testAllocateOverpaymentFailsWhenSettingDisabled() {
     \Civi::settings()->set('financeextras_enable_overpayments', FALSE);
 
-    $contact = ContactFabricator::fabricate();
-    $contribution = $this->createOverpaidContribution($contact['id'], 100.00, 150.00);
+    $contribution = $this->getNextOverpaidContribution();
 
     $this->expectException(\CRM_Core_Exception::class);
     $this->expectExceptionMessage('not eligible');
@@ -203,7 +293,16 @@ public function testAllocateOverpaymentFailsWhenSettingDisabled() {
   public function testAllocateOverpaymentFailsForNonOverpaidContribution() {
     $contact = ContactFabricator::fabricate();
 
-    $contribution = $this->createContribution($contact['id'], 100.00, 'Completed');
+    // Create a non-overpaid contribution using API4 (no Payment.create needed).
+    $contribution = Contribution::create(FALSE)
+      ->addValue('contact_id', $contact['id'])
+      ->addValue('financial_type_id', 1)
+      ->addValue('total_amount', 100)
+      ->addValue('contribution_status_id:name', 'Completed')
+      ->addValue('currency', 'GBP')
+      ->addValue('receive_date', date('Y-m-d'))
+      ->execute()
+      ->first();
 
     $this->expectException(\CRM_Core_Exception::class);
     $this->expectExceptionMessage('not eligible');
@@ -238,8 +337,7 @@ public function testAllocateOverpaymentFailsWhenFinancialTypeNotConfigured() {
       ->addValue('overpayment_financial_type_id', NULL)
       ->execute();
 
-    $contact = ContactFabricator::fabricate();
-    $contribution = $this->createOverpaidContribution($contact['id'], 100.00, 150.00);
+    $contribution = $this->getNextOverpaidContribution();
 
     $this->expectException(\CRM_Core_Exception::class);
     $this->expectExceptionMessage('financial type is not configured');
@@ -253,12 +351,8 @@ public function testAllocateOverpaymentFailsWhenFinancialTypeNotConfigured() {
    * Test credit note remains open with full credit available.
    */
   public function testCreditNoteRemainsOpenWithFullCredit() {
-    $contact = ContactFabricator::fabricate();
-    $invoiceAmount = 100.00;
-    $paidAmount = 175.00;
-    $overpaymentAmount = $paidAmount - $invoiceAmount;
-
-    $contribution = $this->createOverpaidContribution($contact['id'], $invoiceAmount, $paidAmount);
+    $contribution = $this->getLargerOverpaymentContribution();
+    $overpaymentAmount = $contribution['overpayment_amount'];
 
     $result = CreditNote::allocateOverpayment(FALSE)
       ->setContributionId($contribution['id'])
@@ -281,76 +375,4 @@ public function testCreditNoteRemainsOpenWithFullCredit() {
     $this->assertCount(0, $allocations);
   }
 
-  /**
-   * Create an overpaid contribution with 'Pending refund' status.
-   *
-   * @param int $contactId
-   *   The contact ID.
-   * @param float $invoiceAmount
-   *   The invoice amount.
-   * @param float $paidAmount
-   *   The amount paid (greater than invoice).
-   *
-   * @return array
-   *   The created contribution.
-   */
-  private function createOverpaidContribution(int $contactId, float $invoiceAmount, float $paidAmount): array {
-    $trxnId = md5(uniqid());
-
-    $result = civicrm_api3('Contribution', 'create', [
-      'financial_type_id' => 'Donation',
-      'receive_date' => date('Y-m-d'),
-      'total_amount' => $invoiceAmount,
-      'contact_id' => $contactId,
-      'payment_instrument_id' => 'Credit Card',
-      'trxn_id' => $trxnId,
-      'currency' => 'GBP',
-      'contribution_status_id' => 2,
-    ]);
-    $contributionId = $result['id'];
-
-    civicrm_api3('Payment', 'create', [
-      'contribution_id' => $contributionId,
-      'total_amount' => $paidAmount,
-      'trxn_date' => date('Y-m-d H:i:s'),
-      'trxn_id' => $trxnId,
-      'is_send_contribution_notification' => FALSE,
-    ]);
-
-    return Contribution::get(FALSE)
-      ->addWhere('id', '=', $contributionId)
-      ->addSelect('*', 'contribution_status_id:name')
-      ->execute()
-      ->first();
-  }
-
-  /**
-   * Create a contribution with specified status.
-   *
-   * @param int $contactId
-   *   The contact ID.
-   * @param float $amount
-   *   The contribution amount.
-   * @param string $status
-   *   The contribution status.
-   *
-   * @return array
-   *   The created contribution.
-   */
-  private function createContribution(int $contactId, float $amount, string $status): array {
-    $result = civicrm_api3('Contribution', 'create', [
-      'contact_id' => $contactId,
-      'financial_type_id' => 'Donation',
-      'total_amount' => $amount,
-      'contribution_status_id' => $status,
-      'currency' => 'GBP',
-      'receive_date' => date('Y-m-d'),
-    ]);
-
-    return Contribution::get(FALSE)
-      ->addWhere('id', '=', $result['id'])
-      ->execute()
-      ->first();
-  }
-
 }