mkdocs.yml

@@ -17,5 +17,9 @@ markdown_extensions:
 
 nav:
 - Overview: index.md
-- API: api.md
 - Release Notes: releasenotes.md
+- API: api.md
+- Hooks: hooks.md
+- How to implement a payment processor: paymentprocessor.md
+- Refund UI: refunds.md
+- Webhook Queue: webhookqueue.md

phpunit.xml.dist

 <?xml version="1.0"?>
-<phpunit backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" syntaxCheck="false" bootstrap="tests/phpunit/bootstrap.php">
+<phpunit backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" bootstrap="tests/phpunit/bootstrap.php">
   <testsuites>
     <testsuite name="My Test Suite">
       <directory>./tests/phpunit</directory>

schema/PaymentprocessorWebhook.entityType.php

+<?php
+use CRM_Mjwshared_ExtensionUtil as E;
+return [
+  'name' => 'PaymentprocessorWebhook',
+  'table' => 'civicrm_paymentprocessor_webhook',
+  'class' => 'CRM_Mjwshared_DAO_PaymentprocessorWebhook',
+  'getInfo' => fn() => [
+    'title' => E::ts('Paymentprocessor Webhook'),
+    'title_plural' => E::ts('Paymentprocessor Webhooks'),
+    'description' => E::ts('Track the processing of payment processor webhooks'),
+    'log' => TRUE,
+  ],
+  'getIndices' => fn() => [
+    'index_event_id' => [
+      'fields' => [
+        'event_id' => TRUE,
+      ],
+    ],
+    'index_created_date' => [
+      'fields' => [
+        'created_date' => TRUE,
+      ],
+    ],
+    'index_processed_date' => [
+      'fields' => [
+        'processed_date' => TRUE,
+      ],
+    ],
+    'index_status_processed_date' => [
+      'fields' => [
+        'status' => TRUE,
+        'processed_date' => TRUE,
+      ],
+    ],
+    'index_identifier' => [
+      'fields' => [
+        'identifier' => TRUE,
+      ],
+    ],
+  ],
+  'getFields' => fn() => [
+    'id' => [
+      'title' => E::ts('ID'),
+      'sql_type' => 'int unsigned',
+      'input_type' => 'Number',
+      'required' => TRUE,
+      'description' => E::ts('Unique PaymentprocessorWebhook ID'),
+      'primary_key' => TRUE,
+      'auto_increment' => TRUE,
+    ],
+    'payment_processor_id' => [
+      'title' => E::ts('Payment Processor'),
+      'sql_type' => 'int unsigned',
+      'input_type' => 'Select',
+      'description' => E::ts('Payment Processor for this webhook'),
+      'pseudoconstant' => [
+        'table' => 'civicrm_payment_processor',
+        'key_column' => 'id',
+        'label_column' => 'name',
+      ],
+      'entity_reference' => [
+        'entity' => 'PaymentProcessor',
+        'key' => 'id',
+        'on_delete' => 'SET NULL',
+      ],
+    ],
+    'event_id' => [
+      'title' => E::ts('Event ID'),
+      'sql_type' => 'varchar(255)',
+      'input_type' => 'Text',
+      'description' => E::ts('Webhook event ID'),
+    ],
+    'trigger' => [
+      'title' => E::ts('Trigger'),
+      'sql_type' => 'varchar(255)',
+      'input_type' => 'Text',
+      'description' => E::ts('Webhook trigger event type'),
+    ],
+    'created_date' => [
+      'title' => E::ts('Created Date'),
+      'sql_type' => 'timestamp',
+      'input_type' => 'Date',
+      'readonly' => TRUE,
+      'description' => E::ts('When the webhook was first received by the IPN code'),
+      'default' => 'CURRENT_TIMESTAMP',
+    ],
+    'processed_date' => [
+      'title' => E::ts('Processed Date'),
+      'sql_type' => 'timestamp',
+      'input_type' => 'Date',
+      'readonly' => TRUE,
+      'description' => E::ts('Has this webhook been processed yet?'),
+      'default' => NULL,
+    ],
+    'status' => [
+      'title' => E::ts('Status'),
+      'sql_type' => 'varchar(32)',
+      'input_type' => 'Text',
+      'required' => TRUE,
+      'description' => E::ts('Processing status'),
+      'default' => 'new',
+    ],
+    'identifier' => [
+      'title' => E::ts('Identifier'),
+      'sql_type' => 'varchar(255)',
+      'input_type' => 'Text',
+      'description' => E::ts('Optional key to group webhooks, as needed by some processors.'),
+    ],
+    'message' => [
+      'title' => E::ts('Message'),
+      'sql_type' => 'varchar(1024)',
+      'input_type' => 'Text',
+      'description' => E::ts('Stores data sent that is needed for processing. JSON suggested.'),
+      'default' => '',
+    ],
+    'data' => [
+      'title' => E::ts('Data'),
+      'sql_type' => 'text',
+      'input_type' => 'TextArea',
+      'description' => E::ts('Stores data sent that is needed for processing. JSON suggested.'),
+    ],
+  ],
+];

settings/mjwshared.setting.php

+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+use CRM_Mjwshared_ExtensionUtil as E;
+
+return [
+  'mjwshared_refundpaymentui' => [
+    'name' => 'mjwshared_refundpaymentui',
+    'type' => 'Boolean',
+    'html_type' => 'checkbox',
+    'default' => TRUE,
+    'is_domain' => 1,
+    'is_contact' => 0,
+    'title' => E::ts('Enable refund payment via UI?'),
+    'description' => E::ts('Enables a "Refund payment" option next to the edit payment option on Payments. Find payments by expanding contributions.
+    For more detail see the <a href="%1">Refund documentation</a>', [1 => 'https://docs.civicrm.org/mjwshared/en/latest/refunds/']),
+    'html_attributes' => [],
+    'settings_pages' => [
+      'mjwshared' => [
+        'weight' => 21,
+      ]
+    ],
+  ],
+  'mjwshared_disablerecordrefund' => [
+    'name' => 'mjwshared_disablerecordrefund',
+    'type' => 'Boolean',
+    'html_type' => 'checkbox',
+    'default' => FALSE,
+    'is_domain' => 1,
+    'is_contact' => 0,
+    'title' => E::ts('Disable the "Record Refund" link on edit contribution'),
+    'description' => E::ts('By default CiviCRM includes a "Record Refund" link on edit contribution. This can be confusing when our payment refund UI is enabled because the contribution "Record Refund" does not communicate with the payment processor.'),
+    'html_attributes' => [],
+    'settings_pages' => [
+      'mjwshared' => [
+        'weight' => 22,
+      ]
+    ],
+  ],
+  'mjwshared_jsdebug' => [
+    'name' => 'mjwshared_jsdebug',
+    'type' => 'Boolean',
+    'html_type' => 'checkbox',
+    'default' => 0,
+    'is_domain' => 1,
+    'is_contact' => 0,
+    'title' => E::ts('Enable Javascript debugging?'),
+    'description' => E::ts('Enables debug logging to browser console for javascript based payment processors.'),
+    'html_attributes' => [],
+    'settings_pages' => [
+      'mjwshared' => [
+        'weight' => 99,
+      ]
+    ],
+  ],
+];

sql/upgrade_1000.sql

+-- /*******************************************************
+-- *
+-- * civicrm_paymentprocessor_webhook
+-- *
+-- * Track the processing of payment processor webhooks
+-- *
+-- *******************************************************/
+CREATE TABLE `civicrm_paymentprocessor_webhook` (
+  `id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'Unique PaymentprocessorWebhook ID',
+  `payment_processor_id` int unsigned COMMENT 'Payment Processor for this webhook',
+  `event_id` varchar(255) COMMENT 'Webhook event ID',
+  `trigger` varchar(255) COMMENT 'Webhook trigger event type',
+  `created_date` timestamp DEFAULT CURRENT_TIMESTAMP COMMENT 'When the webhook was first received by the IPN code',
+  `processed_date` timestamp NULL DEFAULT NULL COMMENT 'Has this webhook been processed yet?',
+  `status` varchar(255) COMMENT 'Webhook processing status',
+  `identifier` text,
+  PRIMARY KEY (`id`),
+  CONSTRAINT FK_civicrm_paymentprocessor_webhook_payment_processor_id FOREIGN KEY (`payment_processor_id`) REFERENCES `civicrm_payment_processor`(`id`) ON DELETE SET NULL
+) ENGINE=InnoDB;

sql/upgrade_1001.sql

+-- The old default for 'status' field was NULL, new is 'new'
+UPDATE civicrm_paymentprocessor_webhook
+SET status = 'new'
+WHERE status IS NULL
+;
+
+ALTER TABLE civicrm_paymentprocessor_webhook
+MODIFY `status` varchar(32) NOT NULL DEFAULT "new" COMMENT 'Processing status',
+MODIFY `identifier` varchar(255) COMMENT 'Optional key to group webhooks, as needed by some processors.',
+ADD `message` varchar(1024) NOT NULL DEFAULT "" COMMENT 'Stores data sent that is needed for processing. JSON suggested.',
+ADD `data` text COMMENT 'Stores data sent that is needed for processing. JSON suggested.',
+ADD INDEX `index_event_id`(event_id),
+ADD INDEX `index_status_processed_date`(status, processed_date),
+ADD INDEX `index_created_date`(created_date)
+;

templates/CRM/Mjwshared/Form/DrupalWebformBillingBlock.tpl

+{*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+*}
+{* Manually create the CRM.vars.payment here for drupal webform because \Civi::resources()->addVars() does not work in this context *}
+{literal}
+<script type="text/javascript">
+  CRM.$(function($) {
+    $(document).ready(function() {
+      if (typeof CRM.vars.payment === 'undefined') {
+        var paymentJSVars = {{/literal}{foreach from=$paymentJSVars key=arrayKey item=arrayValue}{$arrayKey}:'{$arrayValue}',{/foreach}{literal}};
+        CRM.vars.payment = paymentJSVars;
+      }
+    });
+  });
+</script>
+{/literal}

templates/CRM/Mjwshared/Form/PaymentRefund.tpl

+{crmScope extensionKey='mjwshared'}
+  <h3>Payment details</h3>
+  <div class="crm-section crm-mjwshared-paymentrefund-paymentinfo">
+    <div class="label">{ts}Amount{/ts}</div><div class="content">{$paymentInfo.total_amount|crmMoney:$paymentInfo.currency}</div>
+    <div class="label">{ts}Payment date{/ts}</div><div class="content">{$paymentInfo.trxn_date|crmDate}</div>
+      {if $paymentInfo.trxn_id}<div class="label">{ts}Transaction ID{/ts}</div><div class="content">{$paymentInfo.trxn_id}</div>{/if}
+      {if $paymentInfo.order_reference}<div class="label">{ts}Order Reference{/ts}</div><div class="content">{$paymentInfo.order_reference}</div>{/if}
+      {if $paymentInfo.payment_processor_title}<div class="label">{ts}Payment Processor{/ts}</div><div class="content">{$paymentInfo.payment_processor_title}</div>{/if}
+  </div>
+{if $participants}
+  <h3>{ts}This payment was used to register the following participants:{/ts}</h3>
+  <div class="crm-section crm-mjwshared-paymentrefund-participants">
+    <br />
+    <ul>
+        {foreach from=$participants item=participant}
+          <li>{$participant.display_name}: {$participant.event_title} (<em>{$participant.status}</em>)</li>
+        {/foreach}
+    </ul>
+  </div>
+  <br />
+  <div class="crm-section crm-mjwshared-paymentrefund-participant-canceloption">
+    <div class="label">{$form.cancel_participants.label}</div>
+    <div class="content">{$form.cancel_participants.html}</div>
+    <div class="clear"></div>
+  </div>
+{/if}
+
+{if $memberships}
+  <h3>{ts}This payment was used for the following memberships:{/ts}</h3>
+  <div class="crm-section crm-mjwshared-paymentrefund-memberships">
+    <br />
+    <ul>
+        {foreach from=$memberships item=membership}
+          <li>{$membership.display_name}: {$membership.type} (<em>{$membership.status}</em>)</li>
+        {/foreach}
+    </ul>
+  </div>
+  <br />
+  <div class="crm-section crm-mjwshared-paymentrefund-membership-canceloption">
+    <div class="label">{$form.cancel_memberships.label}</div>
+    <div class="content">{$form.cancel_memberships.html}</div>
+    <div class="clear"></div>
+  </div>
+{/if}
+
+  <div class="crm-section crm-mjwshared-paymentrefund-refundamount">
+    <div class="label">{$form.refund_amount.label}</div>
+    <div class="content">
+      <span id='totalAmount'>{$form.currency.html|crmAddClass:eight}&nbsp;{$form.refund_amount.html|crmAddClass:eight}</span>
+    </div>
+    <div class="clear"></div>
+  </div>
+
+  <div class="help">{ts}Click "refund" to refund this payment{/ts}</div>
+  <div class="crm-submit-buttons">
+      {include file="CRM/common/formButtons.tpl" location="bottom"}
+  </div>
+{/crmScope}

tests/phpunit/CRM/Core/Payment/MJWTraitTest.php

@@ -3,7 +3,8 @@
 use CRM_Mjwshared_ExtensionUtil as E;
 use Civi\Test\HeadlessInterface;
 use Civi\Test\HookInterface;
-use Civi\Test\TransactionalInterface;
+
+require_once(__DIR__ . '/../../../../../CRM/Core/Payment/MJWTrait.php');
 
 /**
  * Test trait functionalty
@@ -19,7 +20,7 @@ use Civi\Test\TransactionalInterface;
  *
  * @group headless
  */
-class CRM_Core_Payment_MJWTraitTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
+class CRM_Core_Payment_MJWTraitTest extends CiviUnitTestCase implements HeadlessInterface, HookInterface {
 
   public function setUpHeadless() {
     // Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
@@ -29,11 +30,13 @@ class CRM_Core_Payment_MJWTraitTest extends \PHPUnit\Framework\TestCase implemen
       ->apply();
   }
 
-  public function setUp() {
+  public function setUp(): void {
     parent::setUp();
   }
 
-  public function tearDown() {
+  public function tearDown(): void {
+    $this->quickCleanUpFinancialEntities();
+    $this->quickCleanup(['civicrm_contact', 'civicrm_email']);
     parent::tearDown();
   }
 
@@ -46,17 +49,16 @@ class CRM_Core_Payment_MJWTraitTest extends \PHPUnit\Framework\TestCase implemen
 
     // First test selection logic when emails are provided in the input array.
     $emails = [
-      "email" => 'other@example.com',
-      "email-Primary" => 'primary@example.com',
+      'email' => 'other@example.com',
+      'email-Primary' => 'primary@example.com',
       "email-$billingLocationId" => 'billing@example.com',
     ];
     $this->assertEquals('billing@example.com',
       $t->getBillingEmail($emails, NULL)
     );
 
-
     array_pop($emails);
-    $this->assertEquals('primary@example.com',
+    $this->assertEquals('other@example.com',
       $t->getBillingEmail($emails, NULL)
     );
 
@@ -66,13 +68,13 @@ class CRM_Core_Payment_MJWTraitTest extends \PHPUnit\Framework\TestCase implemen
     );
 
     // Test that without a contact nor emails, we return null.
-    $this->assertNull($t->getBillingEmail([], NULL));
+    $this->assertEmpty($t->getBillingEmail([], NULL));
 
     // Next test selection logic when emails are not in the input array.
     $contact_id = civicrm_api3('Contact', 'create', ['contact_type' => 'Individual', 'display_name' => 'test contact'])['id'];
 
     // It should return NULL for a contact that has no emails.
-    $this->assertNull($t->getBillingEmail([], $contact_id));
+    $this->assertEmpty($t->getBillingEmail([], $contact_id));
 
     // It should be able to find a single email.
     $email_id_1 = civicrm_api3('Email', 'create', [
@@ -89,7 +91,7 @@ class CRM_Core_Payment_MJWTraitTest extends \PHPUnit\Framework\TestCase implemen
       'contact_id' => $contact_id,
       'email' => 'another@example.com',
     ])['id'];
-    $this->assertRegexp(
+    $this->assertMatchesRegularExpression(
       '/^(an)?other@example.com$/',
       $t->getBillingEmail([], $contact_id),
       'Failed looking up an email for a contact that has more than one.'
@@ -124,5 +126,5 @@ class CRM_Core_Payment_MJWTraitTest extends \PHPUnit\Framework\TestCase implemen
 }
 
 class TheTrait {
-  use CRM_Core_Payment_MJWTrait;
+  use \CRM_Core_Payment_MJWTrait;
 }

tests/phpunit/Civi/Api4/ContributionRecur/UpdateAmountOnRecurMJWTest.php

+<?php
+
+use Civi\Api4\Contribution;
+use Civi\Api4\ContributionRecur;
+use Civi\Api4\PriceField;
+use Civi\Api4\PriceFieldValue;
+use Civi\Test\CiviEnvBuilder;
+use Civi\Test\HeadlessInterface;
+use Civi\Test\HookInterface;
+
+/**
+ * Test the API4 ContributionRecur.UpdateAmountOnRecurMJW
+ *
+ * Tips:
+ *  - With HookInterface, you may implement CiviCRM hooks directly in the test class.
+ *    Simply create corresponding functions (e.g. "hook_civicrm_post(...)" or similar).
+ *  - With TransactionalInterface, any data changes made by setUp() or test****() functions will
+ *    rollback automatically -- as long as you don't manipulate schema or truncate tables.
+ *    If this test needs to manipulate schema or truncate tables, then either:
+ *       a. Do all that using setupHeadless() and Civi\Test.
+ *       b. Disable TransactionalInterface, and handle all setup/teardown yourself.
+ *
+ * @group headless
+ */
+class UpdateAmountOnRecurMJWTest extends CiviUnitTestCase implements HeadlessInterface, HookInterface {
+
+  /**
+   * Setup used when HeadlessInterface is implemented.
+   *
+   * Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
+   *
+   * @link https://github.com/civicrm/org.civicrm.testapalooza/blob/master/civi-test.md
+   *
+   * @return \Civi\Test\CiviEnvBuilder
+   *
+   * @throws \CRM_Extension_Exception_ParseException
+   */
+  public function setUpHeadless(): CiviEnvBuilder {
+    return \Civi\Test::headless()
+      ->installMe(__DIR__)
+      ->apply();
+  }
+
+  public function setUp():void {
+    parent::setUp();
+  }
+
+  public function tearDown():void {
+    $this->quickCleanUpFinancialEntities();
+    $this->quickCleanup(['civicrm_contact']);
+    parent::tearDown();
+  }
+
+  /**
+   * @var int
+   */
+  private int $contributionID;
+
+  /** @var Array name => ContactID */
+  protected array $contacts;
+
+  /** @var Array contactID => recurID */
+  protected array $recurs;
+
+  /**
+   * Populates properties: $this->contacts, $this->recurs.
+   *
+   * Requires $this->pps to be set if $paymentProcessorName is given.
+   *
+   * @var string $paymentProcessorName
+   * @var int $n number of contacts & recurs pairs to create (1 - 3).
+   */
+  protected function createFixture(?string $paymentProcessorName = NULL, int $n = 3) :void {
+    $contacts = array_slice([
+      ['amount' => 1, 'display_name' => 'WilmaUpgrader'],
+      ['amount' => 3, 'display_name' => 'BarneyDowngrader'],
+      ['amount' => 2, 'display_name' => 'EmberMaintainer'],
+    ], 0, $n);
+
+    $records = array_map(function ($_) {
+      unset($_['amount']);
+      return $_;
+    }, $contacts);
+
+    $this->contacts = \Civi\Api4\Contact::save(FALSE)
+      ->setDefaults([
+        'contact_type' => 'Individual',
+      ])
+      ->setRecords($contacts)
+      ->execute()
+      ->indexBy('display_name')
+      ->column('id');
+
+    $defaults = [
+      'currency' => 'USD',
+      'contribution_status_id:name' => 'In Progress',
+      'financial_type_id:name' => 'Donation',
+    ];
+    if ($paymentProcessorName !== NULL) {
+      $defaults['payment_processor_id'] = $this->pps[$paymentProcessorName];
+    }
+    $records = array_map(function ($_) {
+      return ['contact_id' => $this->contacts[$_['display_name']], 'amount' => $_['amount']];
+    }, $contacts);
+    $this->recurs = ContributionRecur::save(FALSE)
+      ->setDefaults($defaults)
+      ->setRecords($records)
+      ->execute()
+      ->indexBy('contact_id')
+      ->column('id');
+
+  }
+
+  private function createOrder() {
+    $financialTypeID = \Civi\Api4\FinancialType::get(FALSE)
+      ->addWhere('name', '=', 'Donation')
+      ->execute()
+      ->first()['id'];
+    $paymentInstrumentID = \Civi\Api4\OptionValue::get(FALSE)
+      ->addWhere('option_group_id:name', '=', 'payment_instrument')
+      ->execute()
+      ->first()['value'];
+
+    foreach ($this->recurs as $contactID => $recurID) {
+      $recur = ContributionRecur::get(FALSE)
+        ->addWhere('id', '=', $recurID)
+        ->execute()
+        ->first();
+
+      $priceFieldValues = \Civi\Api4\PriceFieldValue::getDefaultPriceFieldValueForContributionMJW(FALSE)->execute();
+
+      $orderCreateParams = [
+        'receive_date' => date('YmdHis'),
+        // trxn_date is necessary for membership date calcs.
+        'trxn_date' => date('YmdHis'),
+        'trxn_id' => 'testtrxnid' . $recur['id'],
+        'total_amount' => $recur['amount'],
+        'contact_id' => $contactID,
+        'payment_instrument_id' => $paymentInstrumentID,
+        'currency' => 'USD',
+        'financial_type_id' => $financialTypeID,
+        'is_email_receipt' => FALSE,
+        'is_test' => FALSE,
+        'contribution_recur_id' => $recurID,
+        'contribution_status_id' => 'Pending',
+        'contribution_source' => 'my test description',
+      ];
+      $lineItemParams = [
+        'contact_id' => $contactID,
+      ];
+      $lineItem = [
+        'line_total' => $recur['amount'],
+        'unit_price' => $recur['amount'],
+        'price_field_id' => $priceFieldValues['price_field_id'],
+        'price_field_value_id' => $priceFieldValues['price_field_value_id'],
+        'financial_type_id' => $financialTypeID,
+        'qty' => 1,
+      ];
+      $orderCreateParams['line_items'] = [
+        [
+          'params' => $lineItemParams,
+          'line_item' => [$lineItem]
+        ]
+      ];
+      $this->contributionID = civicrm_api3('Order', 'create', $orderCreateParams)['id'];
+
+      \Civi\Api4\PaymentMJW::create(FALSE)
+        ->addValue('contribution_id', $this->contributionID)
+        ->addValue('total_amount', $recur['amount'])
+        ->addValue('is_send_contribution_notification', FALSE)
+        ->addValue('trxn_date', date('YmdHis'))
+        ->execute();
+    }
+  }
+
+  /**
+   * Test that we can increase an amount on a recurring contribution
+   */
+  public function testNoChangeAmount(): void {
+    $this->createFixture();
+    $this->createOrder();
+
+    // We should not have a template contribution yet
+    $preTemplateContribution = Contribution::get(FALSE)
+      ->addSelect('*', 'line_item.*')
+      ->addJoin('LineItem AS line_item', 'LEFT')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->addWhere('is_template', '=', TRUE)
+      ->addOrderBy('id', 'DESC')
+      ->execute()
+      ->first();
+    $this->assertEmpty($preTemplateContribution);
+
+    $preContributionRecur = ContributionRecur::get(FALSE)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $this->assertNotEmpty($preContributionRecur);
+
+    // But we should have a completed contribution
+    $preContribution = Contribution::get(FALSE)
+      ->addWhere('contribution_status_id:name', '=', 'Completed')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $this->assertNotEmpty($preContribution);
+    $this->assertEquals($preContributionRecur['amount'], $preContribution['total_amount']);
+
+    $newAmount = 1.0;
+    ContributionRecur::updateAmountOnRecurMJW(FALSE)
+      ->addValue('amount', $newAmount)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $updatedRecur = ContributionRecur::get(FALSE)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $templateContribution = Contribution::get(FALSE)
+      ->addSelect('*', 'line_item.*')
+      ->addJoin('LineItem AS line_item', 'LEFT')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->addWhere('is_template', '=', TRUE)
+      ->addOrderBy('id', 'DESC')
+      ->execute()
+      ->first();
+    $this->assertEmpty($templateContribution);
+    $paramsToAssertEqual = [
+      $newAmount => $updatedRecur['amount'],
+    ];
+    foreach ($paramsToAssertEqual as $expected => $actual) {
+      $this->assertEquals($expected, $actual);
+    }
+  }
+
+  /**
+   * Test that we can increase an amount on a recurring contribution
+   */
+  public function testIncreaseAmount(): void {
+    $this->createFixture();
+    $this->createOrder();
+
+    // We should not have a template contribution yet
+    $preTemplateContribution = Contribution::get(FALSE)
+      ->addSelect('*', 'line_item.*')
+      ->addJoin('LineItem AS line_item', 'LEFT')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->addWhere('is_template', '=', TRUE)
+      ->addOrderBy('id', 'DESC')
+      ->execute()
+      ->first();
+    $this->assertEmpty($preTemplateContribution);
+
+    $preContributionRecur = ContributionRecur::get(FALSE)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $this->assertNotEmpty($preContributionRecur);
+
+    // But we should have a completed contribution
+    $preContribution = Contribution::get(FALSE)
+      ->addWhere('contribution_status_id:name', '=', 'Completed')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $this->assertNotEmpty($preContribution);
+    $this->assertEquals($preContributionRecur['amount'], $preContribution['total_amount']);
+
+    $newAmount = 3.0;
+    ContributionRecur::updateAmountOnRecurMJW(FALSE)
+      ->addValue('amount', $newAmount)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $updatedRecur = ContributionRecur::get(FALSE)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $templateContribution = Contribution::get(FALSE)
+      ->addSelect('*', 'line_item.*')
+      ->addJoin('LineItem AS line_item', 'LEFT')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->addWhere('is_template', '=', TRUE)
+      ->addOrderBy('id', 'DESC')
+      ->execute()
+      ->first();
+    $paramsToAssertEqual = [
+      $newAmount => $updatedRecur['amount'],
+      $newAmount => $templateContribution['total_amount'],
+      $newAmount => $templateContribution['line_item.line_total'],
+      0.0 => $templateContribution['fee_amount'],
+    ];
+    foreach ($paramsToAssertEqual as $expected => $actual) {
+      $this->assertEquals($expected, $actual);
+    }
+  }
+
+  /**
+   * Test that we can increase an amount on a recurring contribution
+   */
+  public function testNewAmountZero(): void {
+    $this->createFixture();
+    $this->createOrder();
+
+    // We should not have a template contribution yet
+    $preTemplateContribution = Contribution::get(FALSE)
+      ->addSelect('*', 'line_item.*')
+      ->addJoin('LineItem AS line_item', 'LEFT')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->addWhere('is_template', '=', TRUE)
+      ->addOrderBy('id', 'DESC')
+      ->execute()
+      ->first();
+    $this->assertEmpty($preTemplateContribution);
+
+    $preContributionRecur = ContributionRecur::get(FALSE)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $this->assertNotEmpty($preContributionRecur);
+
+    // But we should have a completed contribution
+    $preContribution = Contribution::get(FALSE)
+      ->addWhere('contribution_status_id:name', '=', 'Completed')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $this->assertNotEmpty($preContribution);
+    $this->assertEquals($preContributionRecur['amount'], $preContribution['total_amount']);
+
+    $newAmount = 0.0;
+    ContributionRecur::updateAmountOnRecurMJW(FALSE)
+      ->addValue('amount', $newAmount)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $updatedRecur = ContributionRecur::get(FALSE)
+      ->addWhere('id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->execute()
+      ->first();
+    $templateContribution = Contribution::get(FALSE)
+      ->addSelect('*', 'line_item.*')
+      ->addJoin('LineItem AS line_item', 'LEFT')
+      ->addWhere('contribution_recur_id', '=', $this->recurs[$this->contacts['WilmaUpgrader']])
+      ->addWhere('is_template', '=', TRUE)
+      ->addOrderBy('id', 'DESC')
+      ->execute()
+      ->first();
+    $paramsToAssertEqual = [
+      $newAmount => $updatedRecur['amount'],
+      $newAmount => $templateContribution['total_amount'],
+      $newAmount => $templateContribution['line_item.line_total'],
+      0.0 => $templateContribution['fee_amount'],
+    ];
+    foreach ($paramsToAssertEqual as $expected => $actual) {
+      $this->assertEquals($expected, $actual);
+    }
+  }
+
+}

tests/phpunit/Civi/Api4/Membership/LinkRecurMJWTest.php

+<?php
+
+use Civi\Api4\Contribution;
+use Civi\Api4\ContributionRecur;
+use Civi\Api4\LineItem;
+use Civi\Api4\Membership;
+use Civi\Api4\PriceField;
+use Civi\Api4\PriceFieldValue;
+use CRM_Mjwshared_ExtensionUtil as E;
+use Civi\Test\CiviEnvBuilder;
+use Civi\Test\HeadlessInterface;
+use Civi\Test\HookInterface;
+use Civi\Test\TransactionalInterface;
+
+/**
+ * Test the API4 ContributionRecur.UpdateAmountOnRecurMJW
+ *
+ * Tips:
+ *  - With HookInterface, you may implement CiviCRM hooks directly in the test class.
+ *    Simply create corresponding functions (e.g. "hook_civicrm_post(...)" or similar).
+ *  - With TransactionalInterface, any data changes made by setUp() or test****() functions will
+ *    rollback automatically -- as long as you don't manipulate schema or truncate tables.
+ *    If this test needs to manipulate schema or truncate tables, then either:
+ *       a. Do all that using setupHeadless() and Civi\Test.
+ *       b. Disable TransactionalInterface, and handle all setup/teardown yourself.
+ *
+ * @group headless
+ */
+class LinkRecurMJWTest extends CiviUnitTestCase implements HeadlessInterface, HookInterface {
+
+  /**
+   * Setup used when HeadlessInterface is implemented.
+   *
+   * Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
+   *
+   * @link https://github.com/civicrm/org.civicrm.testapalooza/blob/master/civi-test.md
+   *
+   * @return \Civi\Test\CiviEnvBuilder
+   *
+   * @throws \CRM_Extension_Exception_ParseException
+   */
+  public function setUpHeadless(): CiviEnvBuilder {
+    return \Civi\Test::headless()
+      ->installMe(__DIR__)
+      ->apply();
+  }
+
+  public function setUp():void {
+    parent::setUp();
+  }
+
+  public function tearDown():void {
+    $this->quickCleanUpFinancialEntities();
+    $this->quickCleanup(['civicrm_contact']);
+    parent::tearDown();
+  }
+
+  /**
+   * Test that we can link a membership to a recur and that all related entities are correctly updated
+   */
+  public function testLinkRecur(): void {
+    $cid = $this->individualCreate();
+    $crid = ContributionRecur::create(FALSE)
+      ->addValue('contact_id', $cid)
+      ->addValue('amount', 5)
+      ->execute()
+      ->first()['id'];
+    $coid = Contribution::create(FALSE)
+      ->addValue('contact_id', $cid)
+      ->addValue('total_amount', 5)
+      ->addValue('contribution_recur_id', $crid)
+      ->addValue('financial_type_id', 1)
+      ->execute()
+      ->first()['id'];
+    $lineItemID = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $coid)
+      ->execute()
+      ->first()['id'];
+    $mid = $this->contactMembershipCreate(['contact_id' => $cid]);
+
+    $priceFieldValueForMembership = PriceFieldValue::getDefaultPriceFieldValueForMembershipMJW(FALSE)
+      ->setMembershipID($mid)
+      ->execute();
+
+    $actualResult = Membership::linkToRecurMJW(FALSE)
+      ->addValue('id', $mid)
+      ->addValue('contribution_recur_id', $crid)
+      ->execute()
+      ->getArrayCopy();
+
+    // Now check results
+    // Check that membership now has contribution_recur_id set
+    $updatedMembership = Membership::get(FALSE)
+      ->addWhere('id', '=', $mid)
+      ->execute()
+      ->first();
+    $this->assertEquals($crid, $updatedMembership['contribution_recur_id']);
+
+    $templateContribution = \CRM_Contribute_BAO_ContributionRecur::getTemplateContribution($crid);
+    $this->assertEquals($crid, $templateContribution['contribution_recur_id']);
+    $templateContributionlineItem = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $templateContribution['id'])
+      ->execute()
+      ->first();
+    $priceFieldValueForContribution = PriceFieldValue::getDefaultPriceFieldValueForContributionMJW(FALSE)->execute();
+    // It would be nice to check the actual values here, but for now let's just check that they are different
+    $this->assertNotEquals($priceFieldValueForContribution['price_field_id'], $priceFieldValueForMembership['price_field_id']);
+    $this->assertNotEquals($priceFieldValueForContribution['price_field_value_id'], $priceFieldValueForMembership['price_field_value_id']);
+    $this->assertNotEquals($priceFieldValueForContribution['label'], $priceFieldValueForMembership['label']);
+
+    $lineItemExpectedActual = [
+      'civicrm_membership' => $templateContributionlineItem['entity_table'],
+      $mid => $templateContributionlineItem['entity_id'],
+    ];
+    foreach ($lineItemExpectedActual as $expected => $actual) {
+      $this->assertEquals($expected, $actual);
+    }
+
+    $expectedResult = [
+      'action' => 'link',
+      'contributionID' => $templateContribution['id'],
+      'contributionRecurID' => $crid,
+      'membershipID' => $mid,
+      'lineItemID' => $templateContributionlineItem['id'],
+    ];
+    $this->assertArrayValuesEqual($expectedResult, $actualResult);
+  }
+
+  /**
+   * Test that we can unlink a membership from a recur and that all related entities are correctly updated
+   */
+  public function testUnlinkRecur(): void {
+    $cid = $this->individualCreate();
+    $crid = ContributionRecur::create(FALSE)
+      ->addValue('contact_id', $cid)
+      ->addValue('amount', 5)
+      ->execute()
+      ->first()['id'];
+    $coid = Contribution::create(FALSE)
+      ->addValue('contact_id', $cid)
+      ->addValue('total_amount', 5)
+      ->addValue('contribution_recur_id', $crid)
+      ->addValue('financial_type_id', 1)
+      ->execute()
+      ->first()['id'];
+    $lineItemID = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $coid)
+      ->execute()
+      ->first()['id'];
+    $mid = $this->contactMembershipCreate(['contribution_recur_id' => $crid, 'contact_id' => $cid]);
+
+    $priceFieldValueForMembership = PriceFieldValue::getDefaultPriceFieldValueForMembershipMJW(FALSE)
+      ->setMembershipID($mid)
+      ->execute();
+
+    $actualResult = Membership::unlinkFromRecurMJW(FALSE)
+      ->addValue('id', $mid)
+      ->addValue('contribution_recur_id', $crid)
+      ->execute()
+      ->getArrayCopy();
+
+    // Now check results
+    // Check that membership no longer has contribution_recur_id set
+    $updatedMembership = Membership::get(FALSE)
+      ->addWhere('id', '=', $mid)
+      ->execute()
+      ->first();
+    $this->assertEmpty($updatedMembership['contribution_recur_id']);
+
+    $templateContribution = \CRM_Contribute_BAO_ContributionRecur::getTemplateContribution($crid);
+    $this->assertEquals($crid, $templateContribution['contribution_recur_id']);
+    $templateContributionlineItem = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $templateContribution['id'])
+      ->execute()
+      ->first();
+    $priceFieldValueForContribution = PriceFieldValue::getDefaultPriceFieldValueForContributionMJW(FALSE)->execute();
+    // It would be nice to check the actual values here, but for now let's just check that they are different
+    $this->assertNotEquals($priceFieldValueForContribution['price_field_id'], $priceFieldValueForMembership['price_field_id']);
+    $this->assertNotEquals($priceFieldValueForContribution['price_field_value_id'], $priceFieldValueForMembership['price_field_value_id']);
+    $this->assertNotEquals($priceFieldValueForContribution['label'], $priceFieldValueForMembership['label']);
+
+    $lineItemExpectedActual = [
+      'civicrm_contribution' => $templateContributionlineItem['entity_table'],
+      $templateContribution['id'] => $templateContributionlineItem['entity_id'],
+    ];
+    foreach ($lineItemExpectedActual as $expected => $actual) {
+      $this->assertEquals($expected, $actual);
+    }
+
+    $expectedResult = [
+      'action' => 'unlink',
+      'contributionID' => $templateContribution['id'],
+      'contributionRecurID' => $crid,
+      'membershipID' => $mid,
+      'lineItemID' => $templateContributionlineItem['id'],
+    ];
+    $this->assertArrayValuesEqual($expectedResult, $actualResult);
+  }
+
+}

tests/phpunit/Civi/Api4/PriceFieldValue/GetDefaultPriceFieldValueMJWTest.php

+<?php
+
+use CRM_Mjwshared_ExtensionUtil as E;
+use Civi\Api4\Contribution;
+use Civi\Api4\LineItem;
+use Civi\Test\CiviEnvBuilder;
+use Civi\Test\HeadlessInterface;
+use Civi\Test\HookInterface;
+
+/**
+ * Test the API4 ContributionRecur.UpdateAmountOnRecurMJW
+ *
+ * Tips:
+ *  - With HookInterface, you may implement CiviCRM hooks directly in the test class.
+ *    Simply create corresponding functions (e.g. "hook_civicrm_post(...)" or similar).
+ *  - With TransactionalInterface, any data changes made by setUp() or test****() functions will
+ *    rollback automatically -- as long as you don't manipulate schema or truncate tables.
+ *    If this test needs to manipulate schema or truncate tables, then either:
+ *       a. Do all that using setupHeadless() and Civi\Test.
+ *       b. Disable TransactionalInterface, and handle all setup/teardown yourself.
+ *
+ * @group headless
+ */
+class GetDefaultPriceFieldValueMJWTest extends CiviUnitTestCase implements HeadlessInterface, HookInterface {
+
+  /**
+   * Setup used when HeadlessInterface is implemented.
+   *
+   * Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
+   *
+   * @link https://github.com/civicrm/org.civicrm.testapalooza/blob/master/civi-test.md
+   *
+   * @return \Civi\Test\CiviEnvBuilder
+   *
+   * @throws \CRM_Extension_Exception_ParseException
+   */
+  public function setUpHeadless(): CiviEnvBuilder {
+    return \Civi\Test::headless()
+      ->installMe(__DIR__)
+      ->apply();
+  }
+
+  public function setUp():void {
+    parent::setUp();
+  }
+
+  public function tearDown():void {
+    $this->quickCleanUpFinancialEntities();
+    $this->quickCleanup(['civicrm_contact']);
+    parent::tearDown();
+  }
+
+  /**
+   * Test that the lineitem has the same values as the defaults retrieved by API
+   */
+  public function testGetDefaultPriceFieldValueForContribution(): void {
+    $cid = $this->individualCreate();
+    $contribution = Contribution::create(FALSE)
+      ->addValue('contact_id', $cid)
+      ->addValue('total_amount', 5)
+      ->addValue('financial_type_id', 1)
+      ->execute()
+      ->first();
+    $lineItem = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $contribution['id'])
+      ->execute()
+      ->first();
+
+    $priceFieldValueForContribution = \Civi\Api4\PriceFieldValue::getDefaultPriceFieldValueForContributionMJW(FALSE)
+      ->execute();
+
+    $this->assertEquals($lineItem['price_field_id'], $priceFieldValueForContribution['price_field_id']);
+    $this->assertEquals($lineItem['price_field_value_id'], $priceFieldValueForContribution['price_field_value_id']);
+    $this->assertEquals($lineItem['label'], $priceFieldValueForContribution['label']);
+  }
+
+  /**
+   * Test that the lineitem has the same values as the defaults retrieved by API
+   */
+  public function testGetDefaultPriceFieldValueForMembership(): void {
+    $cid = $this->individualCreate();
+    $this->membershipTypeCreate(['name' => 'General']);
+
+    // As this is a test we want to get the (newly created) default pricefieldvalueid
+    // for the membership. In order to do it a different way from the API we are testing
+    // we'll just grab the latest by ID (because in this test case it will match the membership above).
+    $priceFieldValue = \Civi\Api4\PriceFieldValue::get(FALSE)
+      ->addOrderBy('id', 'DESC')
+      ->execute()
+      ->first();
+
+    $orderCreateParams = [
+      'total_amount'           => 5,
+      'contact_id'             => $cid,
+      'financial_type_id'      => 'Member Dues',
+      'contribution_status_id' => 'Pending',
+    ];
+    $lineItemParams = [
+      'membership_type_id' => 'General',
+      'contact_id' => $cid,
+      'status_id' => 'Pending',
+    ];
+    $lineItem = [
+      'line_total' => 5,
+      'unit_price' => 5,
+      'price_field_id' => $priceFieldValue['id'],
+      'price_field_value_id' => $priceFieldValue['price_field_id'],
+      // 'financial_type_id' => $this->getFinancialTypeID(),
+      'qty' => 1,
+      'entity_table' => 'civicrm_membership',
+    ];
+
+    $orderCreateParams['line_items'] = [
+      [
+        'params' => $lineItemParams,
+        'line_item' => [$lineItem]
+      ]
+    ];
+    $contribution = civicrm_api3('Order', 'create', $orderCreateParams);
+
+    $lineItemResult = LineItem::get(FALSE)
+      ->addWhere('contribution_id', '=', $contribution['id'])
+      ->execute()
+      ->first();
+    $mmembershipID = $lineItemResult['entity_id'];
+    $priceFieldValueForMembership = \Civi\Api4\PriceFieldValue::getDefaultPriceFieldValueForMembershipMJW(FALSE)
+      ->setMembershipID($mmembershipID)
+      ->execute();
+
+    $this->assertEquals($lineItemResult['price_field_id'], $priceFieldValueForMembership['price_field_id']);
+    $this->assertEquals($lineItemResult['price_field_value_id'], $priceFieldValueForMembership['price_field_value_id']);
+    $this->assertEquals($lineItemResult['label'], $priceFieldValueForMembership['label']);
+  }
+
+}
\ No newline at end of file

tests/phpunit/bootstrap.php

 <?php
 
 ini_set('memory_limit', '2G');
-ini_set('safe_mode', 0);
-// phpcs:ignore
-eval(cv('php:boot --level=classloader', 'phpcode'));
 
+// phpcs:disable
+eval(cv('php:boot --level=classloader', 'phpcode'));
+// phpcs:enable
 // Allow autoloading of PHPUnit helper classes in this extension.
 $loader = new \Composer\Autoload\ClassLoader();
-$loader->add('CRM_', __DIR__);
-$loader->add('Civi\\', __DIR__);
-$loader->add('api_', __DIR__);
-$loader->add('api\\', __DIR__);
+$loader->add('CRM_', [__DIR__ . '/../..', __DIR__]);
+$loader->addPsr4('Civi\\', [__DIR__ . '/../../Civi', __DIR__ . '/Civi']);
+$loader->add('api_', [__DIR__ . '/../..', __DIR__]);
+$loader->addPsr4('api\\', [__DIR__ . '/../../api', __DIR__ . '/api']);
+
 $loader->register();
 
 /**
@@ -20,16 +21,17 @@ $loader->register();
  *   The rest of the command to send.
  * @param string $decode
  *   Ex: 'json' or 'phpcode'.
- * @return string
+ * @return mixed
  *   Response output (if the command executed normally).
+ *   For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.
  * @throws \RuntimeException
  *   If the command terminates abnormally.
  */
-function cv($cmd, $decode = 'json') {
+function cv(string $cmd, string $decode = 'json') {
   $cmd = 'cv ' . $cmd;
-  $descriptorSpec = array(0 => array("pipe", "r"), 1 => array("pipe", "w"), 2 => STDERR);
+  $descriptorSpec = [0 => ['pipe', 'r'], 1 => ['pipe', 'w'], 2 => STDERR];
   $oldOutput = getenv('CV_OUTPUT');
-  putenv("CV_OUTPUT=json");
+  putenv('CV_OUTPUT=json');
 
   // Execute `cv` in the original folder. This is a work-around for
   // phpunit/codeception, which seem to manipulate PWD.
@@ -49,7 +51,7 @@ function cv($cmd, $decode = 'json') {
 
     case 'phpcode':
       // If the last output is /*PHPCODE*/, then we managed to complete execution.
-      if (substr(trim($result), 0, 12) !== "/*BEGINPHP*/" || substr(trim($result), -10) !== "/*ENDPHP*/") {
+      if (substr(trim($result), 0, 12) !== '/*BEGINPHP*/' || substr(trim($result), -10) !== '/*ENDPHP*/') {
         throw new \RuntimeException("Command failed ($cmd):\n$result");
       }
       return $result;

xml/Menu/mjwshared.xml

+<?xml version="1.0"?>
+<menu>
+  <item>
+    <path>civicrm/mjwpayment/refund</path>
+    <page_callback>CRM_Mjwshared_Form_PaymentRefund</page_callback>
+    <title>PaymentRefund</title>
+    <access_arguments>edit contributions</access_arguments>
+  </item>
+</menu>