[policy, no patch] Update allowed changes to current practice for backport of Test API changes

Created on 4 July 2025, about 1 month ago

Problem/Motivation

Followup from 🌱 [policy, maybe patch] Clarify backport policy for testing framework changes, including new BTB tests Closed: outdated . To paraphrase from @xjm in that issue, the discussion there is outdated and from when there were two different testing APIs.

The current policy does not reflect current practice in regard to when changes to the testing API should be backported.

Steps to reproduce

Proposed resolution

Update allowed changes β†’ policy.

Text to be added

Remaining tasks

Agree that testing API additions should be backported to the production and maintenance minor branches.
Make the doc changes

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

πŸ“Œ Task
Status

Active

Version

11.0 πŸ”₯

Component

other

Created by

πŸ‡³πŸ‡ΏNew Zealand quietone

Live updates comments and jobs are added and updated live.
  • Needs release manager review

    It is used to alert the release manager core committer(s) that an issue significantly affects the overall technical debt or release timeline of Drupal, and their signoff is needed. See the governance policy draft for more information.

  • Needs framework manager review

    It is used to alert the framework manager core committer(s) that an issue significantly impacts (or has the potential to impact) multiple subsystems or represents a significant change or addition in architecture or public APIs, and their signoff is needed (see the governance policy draft for more information). If an issue significantly impacts only one subsystem, use Needs subsystem maintainer review instead, and make sure the issue component is set to the correct subsystem.

Sign in to follow issues

Comments & Activities

  • Issue created by @quietone
  • πŸ‡ΊπŸ‡ΈUnited States xjm
  • πŸ‡ΊπŸ‡ΈUnited States xjm
  • πŸ‡¬πŸ‡§United Kingdom catch

    Generally I'm in favour of backporting the test improvements because it helps modules support multiple branches of core with no code changes.

    However that has also been hard with performance tests where the tests themselves that rely on the APIs differ between the branches - to the point where we gave up backporting some changes to 10.x

    e.g. FooTest is added in 10.3 and 11.0, FooTest diverges from the 10.x version in 11.1. FooTestBase gets a new improvement in 11.2 - now the changes to the test itself in 11.1, that can be updated to the new API in 11.2, aren't backportable to 10.3. So you end up having to make a separate backport MR with either only the test API addition, or the API addition and also refactoring the 10.x version of the test.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    Made a suggested text.

  • πŸ‡ΊπŸ‡ΈUnited States xjm

    Is the text proposal just this?

    Testing API additions should be backported

    That's not grammatically parallel with the existing sections. We would want to add a bullet with just the nominal phrase ("testing API additions").

    Also, they're already allowed in minor releases. The idea would be to allow them in not only maintenance minors, but possibly also the patch branch also. So we would add it to that third section.

    We might want to qualify it somehow, e.g.:

    • non-disruptive testing API additions

    Regarding #4, maybe that's an additional bullet for maintenance minors:

    • other easily backported test improvements

    (...or something; there might be a better version of that.)

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    Updated the IS to be more detailed.

  • πŸ‡ΊπŸ‡ΈUnited States xjm

    Again, for point 1 in the IS, I think it should go under patch releases rather than minor releases. Or that's what we're proposing for review, anyway. Non-disruptive testing API additions are already allowed in normal minors as they fall under the category of "new APIs or API improvements with backward compatibility".

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    I have gotten this wrong, removing proposed resolution

  • πŸ‡ΊπŸ‡ΈUnited States xjm

    Oops, I missed a tag (for testing topic maintainer review).

  • πŸ‡¦πŸ‡ΊAustralia larowlan πŸ‡¦πŸ‡ΊπŸ.au GMT+10

    Also generally in favour

Production build 0.71.5 2024